tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
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
9DOCBOOKS := z8530book.xml device-drivers.xml \
10 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
11 writing_usb_driver.xml networking.xml \
12 kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
13 gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
14 genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
15 80211.xml debugobjects.xml sh.xml regulator.xml \
16 alsa-driver-api.xml writing-an-alsa-driver.xml \
17 tracepoint.xml drm.xml media_api.xml w1.xml
18
19include Documentation/DocBook/media/Makefile
20
21###
22# The build process is as follows (targets):
23# (xmldocs) [by docproc]
24# file.tmpl --> file.xml +--> file.ps (psdocs) [by db2ps or xmlto]
25# +--> file.pdf (pdfdocs) [by db2pdf or xmlto]
26# +--> DIR=file (htmldocs) [by xmlto]
27# +--> man/ (mandocs) [by xmlto]
28
29
30# for PDF and PS output you can choose between xmlto and docbook-utils tools
31PDF_METHOD = $(prefer-db2x)
32PS_METHOD = $(prefer-db2x)
33
34
35###
36# The targets that may be used.
37PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
38
39targets += $(DOCBOOKS)
40BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
41xmldocs: $(BOOKS)
42sgmldocs: xmldocs
43
44PS := $(patsubst %.xml, %.ps, $(BOOKS))
45psdocs: $(PS)
46
47PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
48pdfdocs: $(PDF)
49
50HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
51htmldocs: $(HTML)
52 $(call build_main_index)
53 $(call build_images)
54 $(call install_media_images)
55
56MAN := $(patsubst %.xml, %.9, $(BOOKS))
57mandocs: $(MAN)
58 $(if $(wildcard $(obj)/man/*.9),gzip -f $(obj)/man/*.9)
59
60installmandocs: mandocs
61 mkdir -p /usr/local/man/man9/
62 install $(obj)/man/*.9.gz /usr/local/man/man9/
63
64###
65#External programs used
66KERNELDOC = $(srctree)/scripts/kernel-doc
67DOCPROC = $(objtree)/scripts/docproc
68
69XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl
70XMLTOFLAGS += --skip-validation
71
72###
73# DOCPROC is used for two purposes:
74# 1) To generate a dependency list for a .tmpl file
75# 2) To preprocess a .tmpl file and call kernel-doc with
76# appropriate parameters.
77# The following rules are used to generate the .xml documentation
78# required to generate the final targets. (ps, pdf, html).
79quiet_cmd_docproc = DOCPROC $@
80 cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
81define rule_docproc
82 set -e; \
83 $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \
84 $(cmd_$(1)); \
85 ( \
86 echo 'cmd_$@ := $(cmd_$(1))'; \
87 echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
88 ) > $(dir $@).$(notdir $@).cmd
89endef
90
91%.xml: %.tmpl $(KERNELDOC) $(DOCPROC) FORCE
92 $(call if_changed_rule,docproc)
93
94# Tell kbuild to always build the programs
95always := $(hostprogs-y)
96
97notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
98 exit 1
99db2xtemplate = db2TYPE -o $(dir $@) $<
100xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
101
102# determine which methods are available
103ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
104 use-db2x = db2x
105 prefer-db2x = db2x
106else
107 use-db2x = notfound
108 prefer-db2x = $(use-xmlto)
109endif
110ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
111 use-xmlto = xmlto
112 prefer-xmlto = xmlto
113else
114 use-xmlto = notfound
115 prefer-xmlto = $(use-db2x)
116endif
117
118# the commands, generated from the chosen template
119quiet_cmd_db2ps = PS $@
120 cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
121%.ps : %.xml
122 $(call cmd,db2ps)
123
124quiet_cmd_db2pdf = PDF $@
125 cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
126%.pdf : %.xml
127 $(call cmd,db2pdf)
128
129
130index = index.html
131main_idx = $(obj)/$(index)
132build_main_index = rm -rf $(main_idx); \
133 echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
134 echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
135 cat $(HTML) >> $(main_idx)
136
137quiet_cmd_db2html = HTML $@
138 cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
139 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
140 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
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,%,$@)
147 $(call cmd,db2html)
148 @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
149 cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
150
151quiet_cmd_db2man = MAN $@
152 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; fi
153%.9 : %.xml
154 @(which xmlto > /dev/null 2>&1) || \
155 (echo "*** You need to install xmlto ***"; \
156 exit 1)
157 $(Q)mkdir -p $(obj)/man
158 $(call cmd,db2man)
159 @touch $@
160
161###
162# Rules to generate postscripts and PNG images from .fig format files
163quiet_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)
170 $(call cmd,fig2eps)
171
172quiet_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)
179 $(call cmd,fig2png)
180
181###
182# Rule to convert a .c file to inline XML documentation
183 gen_xml = :
184 quiet_gen_xml = echo ' GEN $@'
185silent_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
198dochelp:
199 @echo ' Linux kernel 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
210clean-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
222clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
223
224cleandocs: cleanmediadocs
225 $(Q)rm -f $(call objectify, $(clean-files))
226 $(Q)rm -rf $(call objectify, $(clean-dirs))
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)