From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: dev@dpdk.org
Subject: [dpdk-dev] [PATCH 3/4] mk: clean dead doc rules
Date: Fri, 19 Apr 2013 19:00:22 +0200 [thread overview]
Message-ID: <02ae197360f82eb35c779b6bfb10d6f5cff8bdd4.1366390454.git.thomas.monjalon@6wind.com> (raw)
In-Reply-To: <cover.1366390454.git.thomas.monjalon@6wind.com>
In-Reply-To: <cover.1366390454.git.thomas.monjalon@6wind.com>
It seems that doc/ has been removed so these rules are useless.
This clean-up is preliminary to generate some doc.
Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
mk/rte.doc.mk | 127 -----------------------------------------------------
mk/rte.sdkdoc.mk | 33 +-------------
mk/rte.sdkroot.mk | 9 +---
3 files changed, 4 insertions(+), 165 deletions(-)
delete mode 100644 mk/rte.doc.mk
diff --git a/mk/rte.doc.mk b/mk/rte.doc.mk
deleted file mode 100644
index b57504a..0000000
--- a/mk/rte.doc.mk
+++ /dev/null
@@ -1,127 +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.
-#
-# version: DPDK.L.1.2.3-3
-
-DEFAULT_DPI ?= 300
-
-ifeq ($(BASEDOCDIR),)
-$(error "must be called from RTE root Makefile")
-endif
-ifeq ($(DOCDIR),)
-$(error "must be called from RTE root Makefile")
-endif
-
-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
-
-compare = $(strip $(subst $(1),,$(2)) $(subst $(2),,$(1)))
-dirname = $(patsubst %/,%,$(dir $1))
-
-# windows only: this is needed for native programs that do not handle
-# unix-like paths on win32
-ifdef COMSPEC
-winpath = "$(shell cygpath --windows $(abspath $(1)))"
-else
-winpath = $(1)
-endif
-
-all doc: $(pngfiles) $(htmlfiles) $(pdffiles) $(DIRS)
- @true
-
-htmldoc: $(pngfiles) $(htmlfiles) $(DIRS)
- @true
-
-pdfdoc: $(pngfiles) $(pdffiles) $(DIRS)
- @true
-
-doxydoc: $(pdfimgfiles) $(DIRS)
- @true
-
-.PHONY: $(DIRS)
-$(DIRS):
- @[ -d $(CURDIR)/$@ ] || mkdir -p $(CURDIR)/$@
- $(Q)$(MAKE) DOCDIR=$(DOCDIR)/$@ BASEDOCDIR=$(BASEDOCDIR)/.. \
- -f $(RTE_SDK)/doc/$(DOCDIR)/$@/Makefile -C $(CURDIR)/$@ $(MAKECMDGOALS)
-
-%.png: %.svg
- @echo " INKSCAPE $(@)"
- $(Q)inkscape -d $(DEFAULT_DPI) -D -b ffffff -y 1.0 -e $(call winpath,$(@)) $(call winpath,$(<))
-
-%.pdf: %.svg
- @echo " INKSCAPE $(@)"
- $(Q)inkscape -d $(DEFAULT_DPI) -D -b ffffff -y 1.0 -A $(call winpath,$(@)) $(call winpath,$(<))
-
-.SECONDEXPANSION:
-$(foreach f,$(RST),$(eval DEP_$(f:%.rst=%.html) = $(DEP_$(f))))
-%.html: %.rst $$(DEP_$$@)
- @echo " RST2HTML $(@)"
- $(Q)mkdir -p `dirname $(@)` ; \
- python $(BASEDOCDIR)/gen/gen-common.py html $(BASEDOCDIR) > $(BASEDOCDIR)/gen/rte.rst ; \
- python $(BASEDOCDIR)/html/rst2html-highlight.py --link-stylesheet \
- --stylesheet-path=$(BASEDOCDIR)/html/rte.css \
- --strip-comments< $(<) > $(@) ; \
-
-# there is a bug in rst2pdf (issue 311): replacement of DSTDIR is not
-# what we expect: we should not have to add doc/
-ifdef COMSPEC
-WORKAROUND_PATH=$(BASEDOCDIR)
-else
-WORKAROUND_PATH=$(BASEDOCDIR)/doc
-endif
-
-.SECONDEXPANSION:
-$(foreach f,$(RST),$(eval DEP_$(f:%.rst=%.pdf) = $(DEP_$(f))))
-%.pdf: %.rst $$(DEP_$$@)
- @echo " RST2PDF $(@)"
- $(Q)mkdir -p `dirname $(@)` ; \
- python $(BASEDOCDIR)/gen/gen-common.py pdf $(BASEDOCDIR) > $(BASEDOCDIR)/gen/rte.rst ; \
- rst2pdf -s $(BASEDOCDIR)/pdf/rte-stylesheet.json \
- --default-dpi=300 < $(<) > $(@)
-
-CLEANDIRS = $(addsuffix _clean,$(DIRS))
-
-docclean clean: $(CLEANDIRS)
- @rm -f $(htmlfiles) $(pdffiles) $(pngfiles) $(pdfimgfiles) $(BASEDOCDIR)/gen/rte.rst
-
-%_clean:
- @if [ -f $(RTE_SDK)/doc/$(DOCDIR)/$*/Makefile -a -d $(CURDIR)/$* ]; then \
- $(MAKE) DOCDIR=$(DOCDIR)/$* BASEDOCDIR=$(BASEDOCDIR)/.. \
- -f $(RTE_SDK)/doc/$(DOCDIR)/$*/Makefile -C $(CURDIR)/$* clean ; \
- fi
-
-.NOTPARALLEL:
diff --git a/mk/rte.sdkdoc.mk b/mk/rte.sdkdoc.mk
index 8d7a296..57eb8e6 100644
--- a/mk/rte.sdkdoc.mk
+++ b/mk/rte.sdkdoc.mk
@@ -31,12 +31,6 @@
#
# version: DPDK.L.1.2.3-3
-ifdef O
-ifeq ("$(origin O)", "command line")
-$(error "Cannot use O= with doc target")
-endif
-endif
-
ifdef T
ifeq ("$(origin T)", "command line")
$(error "Cannot use T= with doc target")
@@ -45,29 +39,6 @@ endif
.PHONY: doc
doc:
- $(Q)$(MAKE) -C $(RTE_SDK)/doc/images $@ BASEDOCDIR=.. DOCDIR=images
- $(Q)$(MAKE) -f $(RTE_SDK)/doc/rst/Makefile -C $(RTE_SDK)/doc/pdf pdfdoc BASEDOCDIR=.. DOCDIR=rst
- $(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkdoc.mk doxydoc
-
-.PHONY: pdfdoc
-pdfdoc:
- $(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
-
-.PHONY: doxydoc
-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
-.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
+.PHONY: doc-clean
+doc-clean:
diff --git a/mk/rte.sdkroot.mk b/mk/rte.sdkroot.mk
index 6221bec..fe0070e 100644
--- a/mk/rte.sdkroot.mk
+++ b/mk/rte.sdkroot.mk
@@ -103,8 +103,8 @@ testall testimport:
install uninstall:
$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkinstall.mk $@
-.PHONY: doc pdfdoc doxydoc docclean
-doc pdfdoc doxydoc docclean:
+.PHONY: doc doc-clean
+doc doc-clean:
$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkdoc.mk $@
.PHONY: depdirs depgraph
@@ -115,11 +115,6 @@ depdirs depgraph:
gcov gcovclean:
$(Q)$(MAKE) -f $(RTE_SDK)/mk/rte.sdkgcov.mk $@
-.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
--
1.7.10.4
next prev parent reply other threads:[~2013-04-19 17:01 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-19 17:00 [dpdk-dev] [PATCH 0/4] doc from doxygen Thomas Monjalon
2013-04-19 17:00 ` [dpdk-dev] [PATCH 1/4] lib: fix some doxygen comments Thomas Monjalon
2013-04-19 17:00 ` [dpdk-dev] [PATCH 2/4] mk: factorize some rules Thomas Monjalon
2013-04-19 17:00 ` Thomas Monjalon [this message]
2013-04-19 17:00 ` [dpdk-dev] [PATCH 4/4] doc: generate HTML for API with doxygen Thomas Monjalon
2013-04-24 13:40 ` [dpdk-dev] [PATCH 0/4] doc from doxygen Olivier MATZ
2013-04-26 11:27 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=02ae197360f82eb35c779b6bfb10d6f5cff8bdd4.1366390454.git.thomas.monjalon@6wind.com \
--to=thomas.monjalon@6wind.com \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).