3 # Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
6 # Redistribution and use in source and binary forms, with or without
7 # modification, are permitted provided that the following conditions
10 # * Redistributions of source code must retain the above copyright
11 # notice, this list of conditions and the following disclaimer.
12 # * Redistributions in binary form must reproduce the above copyright
13 # notice, this list of conditions and the following disclaimer in
14 # the documentation and/or other materials provided with the
16 # * Neither the name of Intel Corporation nor the names of its
17 # contributors may be used to endorse or promote products derived
18 # from this software without specific prior written permission.
20 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 $(error "must be called from RTE root Makefile")
38 $(error "must be called from RTE root Makefile")
41 VPATH = $(abspath $(BASEDOCDIR)/$(DOCDIR))
43 pngfiles = $(patsubst %.svg,%.png,$(SVG))
44 pdfimgfiles = $(patsubst %.svg,%.pdf,$(SVG))
45 pdffiles = $(patsubst %.rst,%.pdf,$(RST))
49 compare = $(strip $(subst $(1),,$(2)) $(subst $(2),,$(1)))
50 dirname = $(patsubst %/,%,$(dir $1))
52 # windows only: this is needed for native programs that do not handle
53 # unix-like paths on win32
55 winpath = "$(shell cygpath --windows $(abspath $(1)))"
60 all doc: $(pngfiles) $(pdffiles) $(DIRS)
63 pdfdoc: $(pngfiles) $(pdffiles) $(DIRS)
66 doxydoc: $(pdfimgfiles) $(DIRS)
71 @[ -d $(CURDIR)/$@ ] || mkdir -p $(CURDIR)/$@
72 $(Q)$(MAKE) DOCDIR=$(DOCDIR)/$@ BASEDOCDIR=$(BASEDOCDIR)/.. \
73 -f $(RTE_SDK)/doc/$(DOCDIR)/$@/Makefile -C $(CURDIR)/$@ $(MAKECMDGOALS)
76 @echo " INKSCAPE $(@)"
77 $(Q)inkscape -d $(DEFAULT_DPI) -D -b ffffff -y 1.0 -e $(call winpath,$(@)) $(call winpath,$(<))
80 @echo " INKSCAPE $(@)"
81 $(Q)inkscape -d $(DEFAULT_DPI) -D -b ffffff -y 1.0 -A $(call winpath,$(@)) $(call winpath,$(<))
84 $(foreach f,$(RST),$(eval DEP_$(f:%.rst=%.html) = $(DEP_$(f))))
85 %.html: %.rst $$(DEP_$$@)
86 @echo " RST2HTML $(@)"
87 $(Q)mkdir -p `dirname $(@)` ; \
88 python $(BASEDOCDIR)/gen/gen-common.py html $(BASEDOCDIR) > $(BASEDOCDIR)/gen/rte.rst ; \
89 python $(BASEDOCDIR)/html/rst2html-highlight.py --link-stylesheet \
90 --stylesheet-path=$(BASEDOCDIR)/html/rte.css \
91 --strip-comments< $(<) > $(@) ; \
93 # there is a bug in rst2pdf (issue 311): replacement of DSTDIR is not
94 # what we expect: we should not have to add doc/
96 WORKAROUND_PATH=$(BASEDOCDIR)
98 WORKAROUND_PATH=$(BASEDOCDIR)/doc
102 $(foreach f,$(RST),$(eval DEP_$(f:%.rst=%.pdf) = $(DEP_$(f))))
103 %.pdf: %.rst $$(DEP_$$@)
104 @echo " RST2PDF $(@)"
105 $(Q)mkdir -p `dirname $(@)` ; \
106 python $(BASEDOCDIR)/gen/gen-common.py pdf $(BASEDOCDIR) > $(BASEDOCDIR)/gen/rte.rst ; \
107 rst2pdf -s $(BASEDOCDIR)/pdf/rte-stylesheet.json \
108 --default-dpi=300 < $(<) > $(@)
110 CLEANDIRS = $(addsuffix _clean,$(DIRS))
112 docclean clean: $(CLEANDIRS)
113 @rm -f $(htmlfiles) $(pdffiles) $(pngfiles) $(pdfimgfiles) $(BASEDOCDIR)/gen/rte.rst
116 @if [ -f $(RTE_SDK)/doc/$(DOCDIR)/$*/Makefile -a -d $(CURDIR)/$* ]; then \
117 $(MAKE) DOCDIR=$(DOCDIR)/$* BASEDOCDIR=$(BASEDOCDIR)/.. \
118 -f $(RTE_SDK)/doc/$(DOCDIR)/$*/Makefile -C $(CURDIR)/$* clean ; \