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