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 \ |
60b6dbef | 17 | tracepoint.xml drm.xml media_api.xml w1.xml \ |
aab97877 | 18 | writing_musb_glue_layer.xml crypto-API.xml iio.xml |
42661299 | 19 | |
b12f7374 | 20 | include Documentation/DocBook/media/Makefile |
1da177e4 LT |
21 | |
22 | ### | |
23 | # The build process is as follows (targets): | |
2ac534bc RD |
24 | # (xmldocs) [by docproc] |
25 | # file.tmpl --> file.xml +--> file.ps (psdocs) [by db2ps or xmlto] | |
26 | # +--> file.pdf (pdfdocs) [by db2pdf or xmlto] | |
27 | # +--> DIR=file (htmldocs) [by xmlto] | |
28 | # +--> man/ (mandocs) [by xmlto] | |
1da177e4 | 29 | |
71f95cfb MW |
30 | |
31 | # for PDF and PS output you can choose between xmlto and docbook-utils tools | |
32 | PDF_METHOD = $(prefer-db2x) | |
33 | PS_METHOD = $(prefer-db2x) | |
34 | ||
35 | ||
1da177e4 LT |
36 | ### |
37 | # The targets that may be used. | |
42661299 | 38 | PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs |
1da177e4 | 39 | |
6f89b9c1 | 40 | targets += $(DOCBOOKS) |
1da177e4 | 41 | BOOKS := $(addprefix $(obj)/,$(DOCBOOKS)) |
a435600e | 42 | xmldocs: $(BOOKS) |
1da177e4 LT |
43 | sgmldocs: xmldocs |
44 | ||
45 | PS := $(patsubst %.xml, %.ps, $(BOOKS)) | |
46 | psdocs: $(PS) | |
47 | ||
48 | PDF := $(patsubst %.xml, %.pdf, $(BOOKS)) | |
49 | pdfdocs: $(PDF) | |
50 | ||
f15a3ccd | 51 | HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS))) |
04893043 | 52 | htmldocs: $(HTML) |
eb81d930 | 53 | $(call build_main_index) |
49b14650 | 54 | $(call build_images) |
bd7319dc | 55 | $(call install_media_images) |
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 LT |
66 | |
67 | ### | |
68 | #External programs used | |
5699f871 DCLP |
69 | KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref |
70 | KERNELDOC = $(srctree)/scripts/kernel-doc | |
71 | DOCPROC = $(objtree)/scripts/docproc | |
8b0c2d98 | 72 | |
ec3fadd6 | 73 | XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl |
82c1e49c | 74 | XMLTOFLAGS += --skip-validation |
1da177e4 LT |
75 | |
76 | ### | |
77 | # DOCPROC is used for two purposes: | |
78 | # 1) To generate a dependency list for a .tmpl file | |
79 | # 2) To preprocess a .tmpl file and call kernel-doc with | |
80 | # appropriate parameters. | |
81 | # The following rules are used to generate the .xml documentation | |
82 | # required to generate the final targets. (ps, pdf, html). | |
83 | quiet_cmd_docproc = DOCPROC $@ | |
84 | cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@ | |
85 | define rule_docproc | |
86 | set -e; \ | |
87 | $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \ | |
88 | $(cmd_$(1)); \ | |
89 | ( \ | |
90 | echo 'cmd_$@ := $(cmd_$(1))'; \ | |
91 | echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \ | |
92 | ) > $(dir $@).$(notdir $@).cmd | |
93 | endef | |
94 | ||
5699f871 | 95 | %.xml: %.tmpl $(KERNELDOC) $(DOCPROC) $(KERNELDOCXMLREF) FORCE |
1da177e4 LT |
96 | $(call if_changed_rule,docproc) |
97 | ||
3794f3e8 RD |
98 | # Tell kbuild to always build the programs |
99 | always := $(hostprogs-y) | |
100 | ||
71f95cfb MW |
101 | notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \ |
102 | exit 1 | |
103 | db2xtemplate = db2TYPE -o $(dir $@) $< | |
104 | xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $< | |
105 | ||
106 | # determine which methods are available | |
107 | ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found) | |
108 | use-db2x = db2x | |
109 | prefer-db2x = db2x | |
110 | else | |
111 | use-db2x = notfound | |
112 | prefer-db2x = $(use-xmlto) | |
113 | endif | |
114 | ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found) | |
115 | use-xmlto = xmlto | |
116 | prefer-xmlto = xmlto | |
117 | else | |
118 | use-xmlto = notfound | |
119 | prefer-xmlto = $(use-db2x) | |
120 | endif | |
1da177e4 | 121 | |
71f95cfb MW |
122 | # the commands, generated from the chosen template |
123 | quiet_cmd_db2ps = PS $@ | |
124 | cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template)) | |
1da177e4 | 125 | %.ps : %.xml |
1da177e4 LT |
126 | $(call cmd,db2ps) |
127 | ||
a34645f5 | 128 | quiet_cmd_db2pdf = PDF $@ |
71f95cfb | 129 | cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template)) |
1da177e4 | 130 | %.pdf : %.xml |
1da177e4 LT |
131 | $(call cmd,db2pdf) |
132 | ||
eb81d930 | 133 | |
64e3da10 | 134 | index = index.html |
ec3fadd6 | 135 | main_idx = $(obj)/$(index) |
04893043 | 136 | build_main_index = rm -rf $(main_idx); \ |
eb81d930 BP |
137 | echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \ |
138 | echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \ | |
139 | cat $(HTML) >> $(main_idx) | |
140 | ||
a34645f5 | 141 | quiet_cmd_db2html = HTML $@ |
c4d79a47 | 142 | cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ |
4fa35166 | 143 | echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ |
ec3fadd6 | 144 | $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ |
1da177e4 | 145 | |
5699f871 DCLP |
146 | ### |
147 | # Rules to create an aux XML and .db, and use them to re-process the DocBook XML | |
148 | # to fill internal hyperlinks | |
149 | gen_aux_xml = : | |
150 | quiet_gen_aux_xml = echo ' XMLREF $@' | |
151 | silent_gen_aux_xml = : | |
152 | %.aux.xml: %.xml | |
153 | @$($(quiet)gen_aux_xml) | |
154 | @rm -rf $@ | |
155 | @(cat $< | egrep "^<refentry id" | egrep -o "\".*\"" | cut -f 2 -d \" > $<.db) | |
156 | @$(KERNELDOCXMLREF) -db $<.db $< > $@ | |
157 | .PRECIOUS: %.aux.xml | |
158 | ||
159 | %.html: %.aux.xml | |
8b0c2d98 | 160 | @(which xmlto > /dev/null 2>&1) || \ |
fd4a3244 | 161 | (echo "*** You need to install xmlto ***"; \ |
1da177e4 LT |
162 | exit 1) |
163 | @rm -rf $@ $(patsubst %.html,%,$@) | |
164 | $(call cmd,db2html) | |
165 | @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ | |
166 | cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi | |
167 | ||
71f95cfb | 168 | quiet_cmd_db2man = MAN $@ |
9ed71e7a | 169 | cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man/$(*F) $< ; fi |
8b0c2d98 MW |
170 | %.9 : %.xml |
171 | @(which xmlto > /dev/null 2>&1) || \ | |
fd4a3244 | 172 | (echo "*** You need to install xmlto ***"; \ |
8b0c2d98 | 173 | exit 1) |
9ed71e7a | 174 | $(Q)mkdir -p $(obj)/man/$(*F) |
8b0c2d98 MW |
175 | $(call cmd,db2man) |
176 | @touch $@ | |
1da177e4 LT |
177 | |
178 | ### | |
0f035b8e | 179 | # Rules to generate postscripts and PNG images from .fig format files |
1da177e4 LT |
180 | quiet_cmd_fig2eps = FIG2EPS $@ |
181 | cmd_fig2eps = fig2dev -Leps $< $@ | |
182 | ||
183 | %.eps: %.fig | |
184 | @(which fig2dev > /dev/null 2>&1) || \ | |
185 | (echo "*** You need to install transfig ***"; \ | |
186 | exit 1) | |
187 | $(call cmd,fig2eps) | |
188 | ||
189 | quiet_cmd_fig2png = FIG2PNG $@ | |
190 | cmd_fig2png = fig2dev -Lpng $< $@ | |
191 | ||
192 | %.png: %.fig | |
193 | @(which fig2dev > /dev/null 2>&1) || \ | |
194 | (echo "*** You need to install transfig ***"; \ | |
195 | exit 1) | |
196 | $(call cmd,fig2png) | |
197 | ||
198 | ### | |
199 | # Rule to convert a .c file to inline XML documentation | |
759cd603 MF |
200 | gen_xml = : |
201 | quiet_gen_xml = echo ' GEN $@' | |
202 | silent_gen_xml = : | |
1da177e4 | 203 | %.xml: %.c |
759cd603 | 204 | @$($(quiet)gen_xml) |
1da177e4 LT |
205 | @( \ |
206 | echo "<programlisting>"; \ | |
207 | expand --tabs=8 < $< | \ | |
208 | sed -e "s/&/\\&/g" \ | |
209 | -e "s/</\\</g" \ | |
210 | -e "s/>/\\>/g"; \ | |
211 | echo "</programlisting>") > $@ | |
212 | ||
213 | ### | |
214 | # Help targets as used by the top-level makefile | |
215 | dochelp: | |
6fc52f81 JJ |
216 | @echo ' Linux kernel internal documentation in different formats:' |
217 | @echo ' htmldocs - HTML' | |
6fc52f81 JJ |
218 | @echo ' pdfdocs - PDF' |
219 | @echo ' psdocs - Postscript' | |
220 | @echo ' xmldocs - XML DocBook' | |
2810ae8c RD |
221 | @echo ' mandocs - man pages' |
222 | @echo ' installmandocs - install man pages generated by mandocs' | |
223 | @echo ' cleandocs - clean all generated DocBook files' | |
1da177e4 LT |
224 | |
225 | ### | |
226 | # Temporary files left by various tools | |
227 | clean-files := $(DOCBOOKS) \ | |
5699f871 DCLP |
228 | $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \ |
229 | $(patsubst %.xml, %.aux, $(DOCBOOKS)) \ | |
230 | $(patsubst %.xml, %.tex, $(DOCBOOKS)) \ | |
231 | $(patsubst %.xml, %.log, $(DOCBOOKS)) \ | |
232 | $(patsubst %.xml, %.out, $(DOCBOOKS)) \ | |
233 | $(patsubst %.xml, %.ps, $(DOCBOOKS)) \ | |
234 | $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \ | |
235 | $(patsubst %.xml, %.html, $(DOCBOOKS)) \ | |
236 | $(patsubst %.xml, %.9, $(DOCBOOKS)) \ | |
237 | $(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \ | |
238 | $(patsubst %.xml, %.xml.db, $(DOCBOOKS)) \ | |
239 | $(patsubst %.xml, %.xml, $(DOCBOOKS)) \ | |
82c1e49c | 240 | $(index) |
1da177e4 | 241 | |
42661299 | 242 | clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man |
4f193362 | 243 | |
42661299 | 244 | cleandocs: cleanmediadocs |
2810ae8c RD |
245 | $(Q)rm -f $(call objectify, $(clean-files)) |
246 | $(Q)rm -rf $(call objectify, $(clean-dirs)) | |
247 | ||
4f193362 PS |
248 | # Declare the contents of the .PHONY variable as phony. We keep that |
249 | # information in a variable se we can use it in if_changed and friends. | |
250 | ||
251 | .PHONY: $(PHONY) |