Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | ### |
2 | # This makefile is used to generate the kernel documentation, | |
3 | # primarily based on in-line comments in various source files. | |
4 | # See Documentation/kernel-doc-nano-HOWTO.txt for instruction in how | |
58ef2c4c | 5 | # to document the SRC - and how to read it. |
1da177e4 LT |
6 | # To add a new book the only step required is to add the book to the |
7 | # list of DOCBOOKS. | |
8 | ||
bb8187d3 | 9 | DOCBOOKS := z8530book.xml device-drivers.xml \ |
ac9296f9 | 10 | kernel-hacking.xml kernel-locking.xml deviceiobook.xml \ |
82c1e49c | 11 | writing_usb_driver.xml networking.xml \ |
e3e2aaf7 | 12 | kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \ |
11c869ea | 13 | gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ |
dbbea671 | 14 | genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ |
352de557 | 15 | 80211.xml debugobjects.xml sh.xml regulator.xml \ |
a76f8c6d | 16 | alsa-driver-api.xml writing-an-alsa-driver.xml \ |
c1ece767 | 17 | tracepoint.xml w1.xml \ |
aab97877 | 18 | writing_musb_glue_layer.xml crypto-API.xml iio.xml |
42661299 | 19 | |
bdf107d8 JN |
20 | ifeq ($(DOCBOOKS),) |
21 | ||
22 | # Skip DocBook build if the user explicitly requested no DOCBOOKS. | |
23 | .DEFAULT: | |
24 | @echo " SKIP DocBook $@ target (DOCBOOKS=\"\" specified)." | |
25 | ||
26 | else | |
27 | ||
1da177e4 LT |
28 | ### |
29 | # The build process is as follows (targets): | |
2ac534bc RD |
30 | # (xmldocs) [by docproc] |
31 | # file.tmpl --> file.xml +--> file.ps (psdocs) [by db2ps or xmlto] | |
32 | # +--> file.pdf (pdfdocs) [by db2pdf or xmlto] | |
33 | # +--> DIR=file (htmldocs) [by xmlto] | |
34 | # +--> man/ (mandocs) [by xmlto] | |
1da177e4 | 35 | |
71f95cfb MW |
36 | |
37 | # for PDF and PS output you can choose between xmlto and docbook-utils tools | |
38 | PDF_METHOD = $(prefer-db2x) | |
39 | PS_METHOD = $(prefer-db2x) | |
40 | ||
41 | ||
6f89b9c1 | 42 | targets += $(DOCBOOKS) |
1da177e4 | 43 | BOOKS := $(addprefix $(obj)/,$(DOCBOOKS)) |
a435600e | 44 | xmldocs: $(BOOKS) |
1da177e4 LT |
45 | sgmldocs: xmldocs |
46 | ||
47 | PS := $(patsubst %.xml, %.ps, $(BOOKS)) | |
48 | psdocs: $(PS) | |
49 | ||
50 | PDF := $(patsubst %.xml, %.pdf, $(BOOKS)) | |
51 | pdfdocs: $(PDF) | |
52 | ||
f15a3ccd | 53 | HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS))) |
04893043 | 54 | htmldocs: $(HTML) |
e237b657 | 55 | $(call cmd,build_main_index) |
1da177e4 LT |
56 | |
57 | MAN := $(patsubst %.xml, %.9, $(BOOKS)) | |
58 | mandocs: $(MAN) | |
32c1735c | 59 | find $(obj)/man -name '*.9' | xargs gzip -nf |
1da177e4 LT |
60 | |
61 | installmandocs: mandocs | |
8b0c2d98 | 62 | mkdir -p /usr/local/man/man9/ |
9ed71e7a BH |
63 | find $(obj)/man -name '*.9.gz' -printf '%h %f\n' | \ |
64 | sort -k 2 -k 1 | uniq -f 1 | sed -e 's: :/:' | \ | |
65 | xargs install -m 644 -t /usr/local/man/man9/ | |
1da177e4 | 66 | |
22cba31b JN |
67 | # no-op for the DocBook toolchain |
68 | epubdocs: | |
69 | ||
1da177e4 LT |
70 | ### |
71 | #External programs used | |
5699f871 DCLP |
72 | KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref |
73 | KERNELDOC = $(srctree)/scripts/kernel-doc | |
74 | DOCPROC = $(objtree)/scripts/docproc | |
b479bfd0 BH |
75 | CHECK_LC_CTYPE = $(objtree)/scripts/check-lc_ctype |
76 | ||
77 | # Use a fixed encoding - UTF-8 if the C library has support built-in | |
78 | # or ASCII if not | |
79 | LC_CTYPE := $(call try-run, LC_CTYPE=C.UTF-8 $(CHECK_LC_CTYPE),C.UTF-8,C) | |
80 | export LC_CTYPE | |
8b0c2d98 | 81 | |
ec3fadd6 | 82 | XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl |
82c1e49c | 83 | XMLTOFLAGS += --skip-validation |
1da177e4 LT |
84 | |
85 | ### | |
86 | # DOCPROC is used for two purposes: | |
87 | # 1) To generate a dependency list for a .tmpl file | |
88 | # 2) To preprocess a .tmpl file and call kernel-doc with | |
89 | # appropriate parameters. | |
90 | # The following rules are used to generate the .xml documentation | |
91 | # required to generate the final targets. (ps, pdf, html). | |
92 | quiet_cmd_docproc = DOCPROC $@ | |
93 | cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@ | |
94 | define rule_docproc | |
95 | set -e; \ | |
96 | $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \ | |
97 | $(cmd_$(1)); \ | |
98 | ( \ | |
99 | echo 'cmd_$@ := $(cmd_$(1))'; \ | |
100 | echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \ | |
101 | ) > $(dir $@).$(notdir $@).cmd | |
102 | endef | |
103 | ||
5699f871 | 104 | %.xml: %.tmpl $(KERNELDOC) $(DOCPROC) $(KERNELDOCXMLREF) FORCE |
1da177e4 LT |
105 | $(call if_changed_rule,docproc) |
106 | ||
3794f3e8 RD |
107 | # Tell kbuild to always build the programs |
108 | always := $(hostprogs-y) | |
109 | ||
71f95cfb MW |
110 | notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \ |
111 | exit 1 | |
112 | db2xtemplate = db2TYPE -o $(dir $@) $< | |
113 | xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $< | |
114 | ||
115 | # determine which methods are available | |
116 | ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found) | |
117 | use-db2x = db2x | |
118 | prefer-db2x = db2x | |
119 | else | |
120 | use-db2x = notfound | |
121 | prefer-db2x = $(use-xmlto) | |
122 | endif | |
123 | ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found) | |
124 | use-xmlto = xmlto | |
125 | prefer-xmlto = xmlto | |
126 | else | |
127 | use-xmlto = notfound | |
128 | prefer-xmlto = $(use-db2x) | |
129 | endif | |
1da177e4 | 130 | |
71f95cfb MW |
131 | # the commands, generated from the chosen template |
132 | quiet_cmd_db2ps = PS $@ | |
133 | cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template)) | |
1da177e4 | 134 | %.ps : %.xml |
1da177e4 LT |
135 | $(call cmd,db2ps) |
136 | ||
a34645f5 | 137 | quiet_cmd_db2pdf = PDF $@ |
71f95cfb | 138 | cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template)) |
1da177e4 | 139 | %.pdf : %.xml |
1da177e4 LT |
140 | $(call cmd,db2pdf) |
141 | ||
eb81d930 | 142 | |
64e3da10 | 143 | index = index.html |
ec3fadd6 | 144 | main_idx = $(obj)/$(index) |
e237b657 MCC |
145 | quiet_cmd_build_main_index = HTML $(main_idx) |
146 | cmd_build_main_index = rm -rf $(main_idx); \ | |
eb81d930 BP |
147 | echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \ |
148 | echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \ | |
149 | cat $(HTML) >> $(main_idx) | |
150 | ||
a34645f5 | 151 | quiet_cmd_db2html = HTML $@ |
c4d79a47 | 152 | cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ |
4fa35166 | 153 | echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ |
ec3fadd6 | 154 | $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ |
1da177e4 | 155 | |
5699f871 DCLP |
156 | ### |
157 | # Rules to create an aux XML and .db, and use them to re-process the DocBook XML | |
158 | # to fill internal hyperlinks | |
159 | gen_aux_xml = : | |
160 | quiet_gen_aux_xml = echo ' XMLREF $@' | |
161 | silent_gen_aux_xml = : | |
162 | %.aux.xml: %.xml | |
163 | @$($(quiet)gen_aux_xml) | |
164 | @rm -rf $@ | |
165 | @(cat $< | egrep "^<refentry id" | egrep -o "\".*\"" | cut -f 2 -d \" > $<.db) | |
166 | @$(KERNELDOCXMLREF) -db $<.db $< > $@ | |
167 | .PRECIOUS: %.aux.xml | |
168 | ||
169 | %.html: %.aux.xml | |
8b0c2d98 | 170 | @(which xmlto > /dev/null 2>&1) || \ |
fd4a3244 | 171 | (echo "*** You need to install xmlto ***"; \ |
1da177e4 LT |
172 | exit 1) |
173 | @rm -rf $@ $(patsubst %.html,%,$@) | |
174 | $(call cmd,db2html) | |
175 | @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ | |
176 | cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi | |
177 | ||
71f95cfb | 178 | quiet_cmd_db2man = MAN $@ |
9ed71e7a | 179 | cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man/$(*F) $< ; fi |
8b0c2d98 MW |
180 | %.9 : %.xml |
181 | @(which xmlto > /dev/null 2>&1) || \ | |
fd4a3244 | 182 | (echo "*** You need to install xmlto ***"; \ |
8b0c2d98 | 183 | exit 1) |
9ed71e7a | 184 | $(Q)mkdir -p $(obj)/man/$(*F) |
8b0c2d98 MW |
185 | $(call cmd,db2man) |
186 | @touch $@ | |
1da177e4 LT |
187 | |
188 | ### | |
0f035b8e | 189 | # Rules to generate postscripts and PNG images from .fig format files |
1da177e4 LT |
190 | quiet_cmd_fig2eps = FIG2EPS $@ |
191 | cmd_fig2eps = fig2dev -Leps $< $@ | |
192 | ||
193 | %.eps: %.fig | |
194 | @(which fig2dev > /dev/null 2>&1) || \ | |
195 | (echo "*** You need to install transfig ***"; \ | |
196 | exit 1) | |
197 | $(call cmd,fig2eps) | |
198 | ||
199 | quiet_cmd_fig2png = FIG2PNG $@ | |
200 | cmd_fig2png = fig2dev -Lpng $< $@ | |
201 | ||
202 | %.png: %.fig | |
203 | @(which fig2dev > /dev/null 2>&1) || \ | |
204 | (echo "*** You need to install transfig ***"; \ | |
205 | exit 1) | |
206 | $(call cmd,fig2png) | |
207 | ||
208 | ### | |
209 | # Rule to convert a .c file to inline XML documentation | |
759cd603 MF |
210 | gen_xml = : |
211 | quiet_gen_xml = echo ' GEN $@' | |
212 | silent_gen_xml = : | |
1da177e4 | 213 | %.xml: %.c |
759cd603 | 214 | @$($(quiet)gen_xml) |
1da177e4 LT |
215 | @( \ |
216 | echo "<programlisting>"; \ | |
217 | expand --tabs=8 < $< | \ | |
218 | sed -e "s/&/\\&/g" \ | |
219 | -e "s/</\\</g" \ | |
220 | -e "s/>/\\>/g"; \ | |
221 | echo "</programlisting>") > $@ | |
222 | ||
bdf107d8 | 223 | endif # DOCBOOKS="" |
54721886 | 224 | |
1da177e4 LT |
225 | ### |
226 | # Help targets as used by the top-level makefile | |
227 | dochelp: | |
ebc88ef0 | 228 | @echo ' Linux kernel internal documentation in different formats (DocBook):' |
6fc52f81 | 229 | @echo ' htmldocs - HTML' |
6fc52f81 JJ |
230 | @echo ' pdfdocs - PDF' |
231 | @echo ' psdocs - Postscript' | |
232 | @echo ' xmldocs - XML DocBook' | |
2810ae8c RD |
233 | @echo ' mandocs - man pages' |
234 | @echo ' installmandocs - install man pages generated by mandocs' | |
235 | @echo ' cleandocs - clean all generated DocBook files' | |
e57f0796 | 236 | @echo |
ebc88ef0 | 237 | @echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml' |
e57f0796 | 238 | @echo ' valid values for DOCBOOKS are: $(DOCBOOKS)' |
54721886 | 239 | @echo |
bdf107d8 | 240 | @echo " make DOCBOOKS=\"\" [target] Don't generate docs from Docbook" |
54721886 | 241 | @echo ' This is useful to generate only the ReST docs (Sphinx)' |
e57f0796 | 242 | |
1da177e4 LT |
243 | |
244 | ### | |
245 | # Temporary files left by various tools | |
246 | clean-files := $(DOCBOOKS) \ | |
5699f871 DCLP |
247 | $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \ |
248 | $(patsubst %.xml, %.aux, $(DOCBOOKS)) \ | |
249 | $(patsubst %.xml, %.tex, $(DOCBOOKS)) \ | |
250 | $(patsubst %.xml, %.log, $(DOCBOOKS)) \ | |
251 | $(patsubst %.xml, %.out, $(DOCBOOKS)) \ | |
252 | $(patsubst %.xml, %.ps, $(DOCBOOKS)) \ | |
253 | $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \ | |
254 | $(patsubst %.xml, %.html, $(DOCBOOKS)) \ | |
255 | $(patsubst %.xml, %.9, $(DOCBOOKS)) \ | |
256 | $(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \ | |
257 | $(patsubst %.xml, %.xml.db, $(DOCBOOKS)) \ | |
258 | $(patsubst %.xml, %.xml, $(DOCBOOKS)) \ | |
82c1e49c | 259 | $(index) |
1da177e4 | 260 | |
42661299 | 261 | clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man |
4f193362 | 262 | |
43f71d93 | 263 | cleandocs: |
2810ae8c RD |
264 | $(Q)rm -f $(call objectify, $(clean-files)) |
265 | $(Q)rm -rf $(call objectify, $(clean-dirs)) | |
266 | ||
4f193362 PS |
267 | # Declare the contents of the .PHONY variable as phony. We keep that |
268 | # information in a variable se we can use it in if_changed and friends. | |
269 | ||
270 | .PHONY: $(PHONY) |