]>
Commit | Line | Data |
---|---|---|
30ff8918 MV |
1 | ### |
2 | # This makefile is used to generate the kernel documentation, | |
3 | # primarily based on in-line comments in various source files. | |
8fac9c7b | 4 | # See Documentation/kernel-doc-nano-HOWTO.txt for instruction in how |
30ff8918 MV |
5 | # to document the SRC - and how to read it. |
6 | # To add a new book the only step required is to add the book to the | |
7 | # list of DOCBOOKS. | |
8 | ||
e3ff797c | 9 | DOCBOOKS := fs.xml linker_lists.xml stdio.xml |
30ff8918 MV |
10 | |
11 | ### | |
12 | # The build process is as follows (targets): | |
13 | # (xmldocs) [by docproc] | |
14 | # file.tmpl --> file.xml +--> file.ps (psdocs) [by db2ps or xmlto] | |
15 | # +--> file.pdf (pdfdocs) [by db2pdf or xmlto] | |
16 | # +--> DIR=file (htmldocs) [by xmlto] | |
17 | # +--> man/ (mandocs) [by xmlto] | |
18 | ||
19 | ||
20 | # for PDF and PS output you can choose between xmlto and docbook-utils tools | |
21 | PDF_METHOD = $(prefer-db2x) | |
22 | PS_METHOD = $(prefer-db2x) | |
23 | ||
24 | ||
25 | ### | |
26 | # The targets that may be used. | |
6825a95b | 27 | PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs |
30ff8918 | 28 | |
6825a95b | 29 | BOOKS := $(addprefix $(obj)/,$(DOCBOOKS)) |
30ff8918 MV |
30 | xmldocs: $(BOOKS) |
31 | sgmldocs: xmldocs | |
32 | ||
33 | PS := $(patsubst %.xml, %.ps, $(BOOKS)) | |
34 | psdocs: $(PS) | |
35 | ||
36 | PDF := $(patsubst %.xml, %.pdf, $(BOOKS)) | |
37 | pdfdocs: $(PDF) | |
38 | ||
39 | HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS))) | |
40 | htmldocs: $(HTML) | |
41 | $(call build_main_index) | |
42 | $(call build_images) | |
43 | $(call install_media_images) | |
44 | ||
45 | MAN := $(patsubst %.xml, %.9, $(BOOKS)) | |
46 | mandocs: $(MAN) | |
47 | ||
48 | installmandocs: mandocs | |
49 | mkdir -p /usr/local/man/man9/ | |
50 | install doc/DocBook/man/*.9.gz /usr/local/man/man9/ | |
51 | ||
52 | ### | |
53 | #External programs used | |
8fac9c7b MY |
54 | KERNELDOC = $(srctree)/scripts/kernel-doc |
55 | DOCPROC = $(objtree)/scripts/docproc | |
30ff8918 | 56 | |
6825a95b | 57 | XMLTOFLAGS = -m $(srctree)/doc/DocBook/stylesheet.xsl |
30ff8918 MV |
58 | XMLTOFLAGS += --skip-validation |
59 | ||
60 | ### | |
61 | # DOCPROC is used for two purposes: | |
62 | # 1) To generate a dependency list for a .tmpl file | |
63 | # 2) To preprocess a .tmpl file and call kernel-doc with | |
64 | # appropriate parameters. | |
65 | # The following rules are used to generate the .xml documentation | |
66 | # required to generate the final targets. (ps, pdf, html). | |
6825a95b MY |
67 | quiet_cmd_docproc = DOCPROC $@ |
68 | cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@ | |
69 | define rule_docproc | |
70 | set -e; \ | |
71 | $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \ | |
72 | $(cmd_$(1)); \ | |
73 | ( \ | |
74 | echo 'cmd_$@ := $(cmd_$(1))'; \ | |
75 | echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \ | |
76 | ) > $(dir $@).$(notdir $@).cmd | |
77 | endef | |
78 | ||
79 | %.xml: %.tmpl FORCE | |
80 | $(call if_changed_rule,docproc) | |
81 | ||
82 | ### | |
83 | #Read in all saved dependency files | |
84 | cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd)) | |
85 | ||
86 | ifneq ($(cmd_files),) | |
87 | include $(cmd_files) | |
30ff8918 MV |
88 | endif |
89 | ||
90 | ### | |
91 | # Changes in kernel-doc force a rebuild of all documentation | |
92 | $(BOOKS): $(KERNELDOC) | |
93 | ||
6825a95b MY |
94 | # Tell kbuild to always build the programs |
95 | always := $(hostprogs-y) | |
96 | ||
30ff8918 MV |
97 | notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \ |
98 | exit 1 | |
99 | db2xtemplate = db2TYPE -o $(dir $@) $< | |
100 | xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $< | |
101 | ||
102 | # determine which methods are available | |
103 | ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found) | |
104 | use-db2x = db2x | |
105 | prefer-db2x = db2x | |
106 | else | |
107 | use-db2x = notfound | |
108 | prefer-db2x = $(use-xmlto) | |
109 | endif | |
110 | ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found) | |
111 | use-xmlto = xmlto | |
112 | prefer-xmlto = xmlto | |
113 | else | |
114 | use-xmlto = notfound | |
115 | prefer-xmlto = $(use-db2x) | |
116 | endif | |
117 | ||
118 | # the commands, generated from the chosen template | |
119 | quiet_cmd_db2ps = PS $@ | |
120 | cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template)) | |
121 | %.ps : %.xml | |
6825a95b | 122 | $(call cmd,db2ps) |
30ff8918 MV |
123 | |
124 | quiet_cmd_db2pdf = PDF $@ | |
125 | cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template)) | |
126 | %.pdf : %.xml | |
6825a95b | 127 | $(call cmd,db2pdf) |
30ff8918 MV |
128 | |
129 | ||
130 | index = index.html | |
9e414032 | 131 | main_idx = doc/DocBook/$(index) |
30ff8918 MV |
132 | build_main_index = rm -rf $(main_idx); \ |
133 | echo '<h1>U-Boot Bootloader HTML Documentation</h1>' >> $(main_idx) && \ | |
134 | echo '<h2>U-Boot Version: $(U_BOOT_VERSION)</h2>' >> $(main_idx) && \ | |
135 | cat $(HTML) >> $(main_idx) | |
136 | ||
30ff8918 | 137 | quiet_cmd_db2html = HTML $@ |
8fac9c7b | 138 | cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ |
30ff8918 | 139 | echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ |
6825a95b | 140 | $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ |
30ff8918 MV |
141 | |
142 | %.html: %.xml | |
143 | @(which xmlto > /dev/null 2>&1) || \ | |
144 | (echo "*** You need to install xmlto ***"; \ | |
145 | exit 1) | |
146 | @rm -rf $@ $(patsubst %.html,%,$@) | |
6825a95b | 147 | $(call cmd,db2html) |
30ff8918 | 148 | @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ |
6825a95b | 149 | cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi |
30ff8918 MV |
150 | |
151 | quiet_cmd_db2man = MAN $@ | |
152 | cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi | |
153 | %.9 : %.xml | |
154 | @(which xmlto > /dev/null 2>&1) || \ | |
155 | (echo "*** You need to install xmlto ***"; \ | |
156 | exit 1) | |
9e414032 | 157 | $(Q)mkdir -p $(obj)/man |
6825a95b | 158 | $(call cmd,db2man) |
30ff8918 MV |
159 | @touch $@ |
160 | ||
161 | ### | |
162 | # Rules to generate postscripts and PNG images from .fig format files | |
163 | quiet_cmd_fig2eps = FIG2EPS $@ | |
164 | cmd_fig2eps = fig2dev -Leps $< $@ | |
165 | ||
166 | %.eps: %.fig | |
167 | @(which fig2dev > /dev/null 2>&1) || \ | |
168 | (echo "*** You need to install transfig ***"; \ | |
169 | exit 1) | |
6825a95b | 170 | $(call cmd,fig2eps) |
30ff8918 MV |
171 | |
172 | quiet_cmd_fig2png = FIG2PNG $@ | |
173 | cmd_fig2png = fig2dev -Lpng $< $@ | |
174 | ||
175 | %.png: %.fig | |
176 | @(which fig2dev > /dev/null 2>&1) || \ | |
177 | (echo "*** You need to install transfig ***"; \ | |
178 | exit 1) | |
6825a95b | 179 | $(call cmd,fig2png) |
30ff8918 MV |
180 | |
181 | ### | |
182 | # Rule to convert a .c file to inline XML documentation | |
183 | gen_xml = : | |
184 | quiet_gen_xml = echo ' GEN $@' | |
185 | silent_gen_xml = : | |
186 | %.xml: %.c | |
187 | @$($(quiet)gen_xml) | |
188 | @( \ | |
189 | echo "<programlisting>"; \ | |
190 | expand --tabs=8 < $< | \ | |
191 | sed -e "s/&/\\&/g" \ | |
192 | -e "s/</\\</g" \ | |
193 | -e "s/>/\\>/g"; \ | |
194 | echo "</programlisting>") > $@ | |
195 | ||
196 | ### | |
197 | # Help targets as used by the top-level makefile | |
198 | dochelp: | |
199 | @echo ' U-Boot bootloader internal documentation in different formats:' | |
200 | @echo ' htmldocs - HTML' | |
201 | @echo ' pdfdocs - PDF' | |
202 | @echo ' psdocs - Postscript' | |
203 | @echo ' xmldocs - XML DocBook' | |
204 | @echo ' mandocs - man pages' | |
205 | @echo ' installmandocs - install man pages generated by mandocs' | |
206 | @echo ' cleandocs - clean all generated DocBook files' | |
207 | ||
208 | ### | |
209 | # Temporary files left by various tools | |
210 | clean-files := $(DOCBOOKS) \ | |
211 | $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \ | |
212 | $(patsubst %.xml, %.aux, $(DOCBOOKS)) \ | |
213 | $(patsubst %.xml, %.tex, $(DOCBOOKS)) \ | |
214 | $(patsubst %.xml, %.log, $(DOCBOOKS)) \ | |
215 | $(patsubst %.xml, %.out, $(DOCBOOKS)) \ | |
216 | $(patsubst %.xml, %.ps, $(DOCBOOKS)) \ | |
217 | $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \ | |
218 | $(patsubst %.xml, %.html, $(DOCBOOKS)) \ | |
219 | $(patsubst %.xml, %.9, $(DOCBOOKS)) \ | |
220 | $(index) | |
221 | ||
222 | clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man | |
223 | ||
224 | cleandocs: | |
8fac9c7b MY |
225 | $(Q)rm -f $(call objectify, $(clean-files)) |
226 | $(Q)rm -rf $(call objectify, $(clean-dirs)) | |
30ff8918 MV |
227 | |
228 | # Declare the contents of the .PHONY variable as phony. We keep that | |
229 | # information in a variable se we can use it in if_changed and friends. | |
230 | ||
231 | .PHONY: $(PHONY) |