From 68bbafce3c3c98f7b5e75f778685e5cfd9b97ecc Mon Sep 17 00:00:00 2001 From: Intel Date: Thu, 20 Dec 2012 00:00:00 +0100 Subject: [PATCH] doc: remove remaining references Signed-off-by: Intel --- mk/internal/rte.exthelp-post.mk | 40 --------------- mk/rte.doc.mk | 6 +-- mk/rte.extapp.mk | 1 - mk/rte.extlib.mk | 1 - mk/rte.extobj.mk | 1 - mk/rte.sdkdoc.mk | 6 +-- mk/rte.sdkroot.mk | 9 ---- mk/rte.sdktestall.mk | 6 --- scripts/import_autotest.sh | 86 --------------------------------- 9 files changed, 4 insertions(+), 152 deletions(-) delete mode 100644 mk/internal/rte.exthelp-post.mk delete mode 100755 scripts/import_autotest.sh diff --git a/mk/internal/rte.exthelp-post.mk b/mk/internal/rte.exthelp-post.mk deleted file mode 100644 index 04cad1921a..0000000000 --- a/mk/internal/rte.exthelp-post.mk +++ /dev/null @@ -1,40 +0,0 @@ -# BSD LICENSE -# -# Copyright(c) 2010-2012 Intel Corporation. All rights reserved. -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions -# are met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in -# the documentation and/or other materials provided with the -# distribution. -# * Neither the name of Intel Corporation nor the names of its -# contributors may be used to endorse or promote products derived -# from this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# - -HELP_FILE = $(RTE_SDK)/doc/rst/developpers_reference/app_mkhelp.rst - -help: - @if [ ! -f $(HELP_FILE) ]; then \ - echo "Cannot find RTE SDK documentation" ; \ - exit 0 ; \ - fi - @sed -e '1,/.*OF THE POSSIBILITY OF SUCH DAMAGE.*/ d' $(HELP_FILE) diff --git a/mk/rte.doc.mk b/mk/rte.doc.mk index cbde24b7db..5ce33a9d1b 100644 --- a/mk/rte.doc.mk +++ b/mk/rte.doc.mk @@ -43,7 +43,6 @@ VPATH = $(abspath $(BASEDOCDIR)/$(DOCDIR)) pngfiles = $(patsubst %.svg,%.png,$(SVG)) pdfimgfiles = $(patsubst %.svg,%.pdf,$(SVG)) -htmlfiles = $(patsubst %.rst,%.html,$(RST)) pdffiles = $(patsubst %.rst,%.pdf,$(RST)) .PHONY: all doc clean @@ -59,10 +58,7 @@ else winpath = $(1) endif -all doc: $(pngfiles) $(htmlfiles) $(pdffiles) $(DIRS) - @true - -htmldoc: $(pngfiles) $(htmlfiles) $(DIRS) +all doc: $(pngfiles) $(pdffiles) $(DIRS) @true pdfdoc: $(pngfiles) $(pdffiles) $(DIRS) diff --git a/mk/rte.extapp.mk b/mk/rte.extapp.mk index ec8bdc2df2..7372da9a2a 100644 --- a/mk/rte.extapp.mk +++ b/mk/rte.extapp.mk @@ -52,4 +52,3 @@ else include $(RTE_SDK)/mk/rte.app.mk endif -include $(RTE_SDK)/mk/internal/rte.exthelp-post.mk diff --git a/mk/rte.extlib.mk b/mk/rte.extlib.mk index 4c21a4c01f..07fea7e730 100644 --- a/mk/rte.extlib.mk +++ b/mk/rte.extlib.mk @@ -52,4 +52,3 @@ else include $(RTE_SDK)/mk/rte.lib.mk endif -include $(RTE_SDK)/mk/internal/rte.exthelp-post.mk diff --git a/mk/rte.extobj.mk b/mk/rte.extobj.mk index c84e03df4d..ea80f0f54b 100644 --- a/mk/rte.extobj.mk +++ b/mk/rte.extobj.mk @@ -52,4 +52,3 @@ else include $(RTE_SDK)/mk/rte.obj.mk endif -include $(RTE_SDK)/mk/internal/rte.exthelp-post.mk diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk index f626fae5f1..035f895833 100644 --- a/mk/rte.sdkdoc.mk +++ b/mk/rte.sdkdoc.mk @@ -57,16 +57,16 @@ pdfdoc: doxydoc: $(Q)$(MAKE) -C $(RTE_SDK)/doc/images $@ BASEDOCDIR=.. DOCDIR=images $(Q)mkdir -p $(RTE_SDK)/doc/latex - $(Q)mkdir -p $(RTE_SDK)/doc/pdf/api $(Q)cat $(RTE_SDK)/doc/gen/doxygen_pdf/Doxyfile | doxygen - $(Q)mv $(RTE_SDK)/doc/images/*.pdf $(RTE_SDK)/doc/latex/ $(Q)sed -i s/darkgray/headercolour/g $(RTE_SDK)/doc/latex/doxygen.sty $(Q)cp $(RTE_SDK)/doc/gen/doxygen_pdf/Makefile_doxygen $(RTE_SDK)/doc/latex/Makefile $(Q)$(MAKE) -C $(RTE_SDK)/doc/latex - $(Q)cp $(RTE_SDK)/doc/latex/refman.pdf $(RTE_SDK)/doc/pdf/api/api.pdf + $(Q)mv $(RTE_SDK)/doc/latex/refman.pdf $(RTE_SDK)/doc/api_gen.pdf + $(Q)rm -rf $(RTE_SDK)/doc/latex .PHONY: docclean docclean: $(Q)$(MAKE) -C $(RTE_SDK)/doc/images $@ BASEDOCDIR=.. DOCDIR=images $(Q)$(MAKE) -f $(RTE_SDK)/doc/rst/Makefile -C $(RTE_SDK)/doc/pdf $@ BASEDOCDIR=.. DOCDIR=rst - $(Q)rm -rf $(RTE_SDK)/doc/pdf/api $(RTE_SDK)/doc/latex + $(Q)rm -rf $(RTE_SDK)/doc/latex diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk index f5cfb1f104..bcf9fa594c 100644 --- a/mk/rte.sdkroot.mk +++ b/mk/rte.sdkroot.mk @@ -102,10 +102,6 @@ fast_test ring_test mempool_test: testall: $(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdktestall.mk testall -.PHONY: testimport -testimport: - $(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdktestall.mk testimport - .PHONY: install install: $(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkinstall.mk install @@ -146,11 +142,6 @@ gcovclean: gcov: $(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkgcov.mk gcov -.PHONY: help -help: - @sed -e '1,/.*==================================.*/ d' \ - doc/rst/developers_reference/sdk_mkhelp.rst - # all other build targets %: $(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkconfig.mk checkconfig diff --git a/mk/rte.sdktestall.mk b/mk/rte.sdktestall.mk index 9ca0f803c6..a3ff2d482d 100644 --- a/mk/rte.sdktestall.mk +++ b/mk/rte.sdktestall.mk @@ -56,9 +56,3 @@ testall: $(TESTALL_TARGETS) %_testall: @echo ================== Test $* $(Q)$(MAKE) test O=$* - -# -# import autotests in documentation -# -testimport: - $(Q)$(RTE_SDK)/scripts/import_autotest.sh $(TESTALL_CONFIGS) diff --git a/scripts/import_autotest.sh b/scripts/import_autotest.sh deleted file mode 100755 index 2430d21200..0000000000 --- a/scripts/import_autotest.sh +++ /dev/null @@ -1,86 +0,0 @@ -#!/bin/sh - -# BSD LICENSE -# -# Copyright(c) 2010-2012 Intel Corporation. All rights reserved. -# All rights reserved. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions -# are met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in -# the documentation and/or other materials provided with the -# distribution. -# * Neither the name of Intel Corporation nor the names of its -# contributors may be used to endorse or promote products derived -# from this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -# - -# -# import autotests in documentation -# called by rte.sdktestall.mk from RTE_SDK root directory -# arguments are the list of targets -# - -echo "This will overwrite current autotest results in doc/rst/test_report" -echo "and in doc/images/ directories" -echo -n "Are you sure ? [y/N] >" -read ans -if [ "$ans" != "y" -a "$ans" != "Y" ]; then - echo "Aborted" - exit 0 -fi - -rm doc/images/autotests/Makefile - -for t in $*; do - echo -------- $t - rm -rf doc/rst/test_report/autotests/$t - - # no autotest dir, skip - if ! ls -d $t/autotest-*/*.rst 2> /dev/null > /dev/null; then - continue; - fi - - for f in $t/autotest*/*.rst; do - if [ ! -f $f ]; then - continue - fi - mkdir -p doc/rst/test_report/autotests/$t - cp $f doc/rst/test_report/autotests/$t - done - rm -rf doc/images/autotests/$t - for f in $t/autotest*/*.svg; do - if [ ! -f $f ]; then - continue - fi - mkdir -p doc/images/autotests/$t - cp $f doc/images/autotests/$t - echo "SVG += `basename $f`" >> doc/images/autotests/$t/Makefile - done - - if [ -f doc/images/autotests/$t/Makefile ]; then - echo >> doc/images/autotests/$t/Makefile - echo 'include $(RTE_SDK)/mk/rte.doc.mk' >> doc/images/autotests/$t/Makefile - fi - - echo "DIRS += $t" >> doc/images/autotests/Makefile -done - -echo 'include $(RTE_SDK)/mk/rte.doc.mk' >> doc/images/autotests/Makefile -- 2.20.1