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
9 DOCBOOKS := z8530book.xml mcabook.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
19 include $(srctree)/Documentation/DocBook/media/Makefile
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]
30 # for PDF and PS output you can choose between xmlto and docbook-utils tools
31 PDF_METHOD = $(prefer-db2x)
32 PS_METHOD = $(prefer-db2x)
36 # The targets that may be used.
37 PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
39 BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
43 PS := $(patsubst %.xml, %.ps, $(BOOKS))
46 PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
49 HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
51 $(call build_main_index)
54 MAN := $(patsubst %.xml, %.9, $(BOOKS))
57 installmandocs: mandocs
58 mkdir -p /usr/local/man/man9/
59 install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
62 #External programs used
63 KERNELDOC = $(srctree)/scripts/kernel-doc
64 DOCPROC = $(objtree)/scripts/docproc
66 XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
67 XMLTOFLAGS += --skip-validation
70 # DOCPROC is used for two purposes:
71 # 1) To generate a dependency list for a .tmpl file
72 # 2) To preprocess a .tmpl file and call kernel-doc with
73 # appropriate parameters.
74 # The following rules are used to generate the .xml documentation
75 # required to generate the final targets. (ps, pdf, html).
76 quiet_cmd_docproc = DOCPROC $@
77 cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
80 $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \
83 echo 'cmd_$@ := $(cmd_$(1))'; \
84 echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
85 ) > $(dir $@).$(notdir $@).cmd
89 $(call if_changed_rule,docproc)
92 #Read in all saved dependency files
93 cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
100 # Changes in kernel-doc force a rebuild of all documentation
101 $(BOOKS): $(KERNELDOC)
103 # Tell kbuild to always build the programs
104 always := $(hostprogs-y)
106 notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
108 db2xtemplate = db2TYPE -o $(dir $@) $<
109 xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
111 # determine which methods are available
112 ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
117 prefer-db2x = $(use-xmlto)
119 ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
124 prefer-xmlto = $(use-db2x)
127 # the commands, generated from the chosen template
128 quiet_cmd_db2ps = PS $@
129 cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
133 quiet_cmd_db2pdf = PDF $@
134 cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
140 main_idx = Documentation/DocBook/$(index)
141 build_main_index = rm -rf $(main_idx); \
142 echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
143 echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
144 cat $(HTML) >> $(main_idx)
146 quiet_cmd_db2html = HTML $@
147 cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
148 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
149 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
152 @(which xmlto > /dev/null 2>&1) || \
153 (echo "*** You need to install xmlto ***"; \
155 @rm -rf $@ $(patsubst %.html,%,$@)
157 @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
158 cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
160 quiet_cmd_db2man = MAN $@
161 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
163 @(which xmlto > /dev/null 2>&1) || \
164 (echo "*** You need to install xmlto ***"; \
166 $(Q)mkdir -p $(obj)/man
171 # Rules to generate postscripts and PNG images from .fig format files
172 quiet_cmd_fig2eps = FIG2EPS $@
173 cmd_fig2eps = fig2dev -Leps $< $@
176 @(which fig2dev > /dev/null 2>&1) || \
177 (echo "*** You need to install transfig ***"; \
181 quiet_cmd_fig2png = FIG2PNG $@
182 cmd_fig2png = fig2dev -Lpng $< $@
185 @(which fig2dev > /dev/null 2>&1) || \
186 (echo "*** You need to install transfig ***"; \
191 # Rule to convert a .c file to inline XML documentation
193 quiet_gen_xml = echo ' GEN $@'
198 echo "<programlisting>"; \
199 expand --tabs=8 < $< | \
200 sed -e "s/&/\\&/g" \
203 echo "</programlisting>") > $@
206 # Help targets as used by the top-level makefile
208 @echo ' Linux kernel internal documentation in different formats:'
209 @echo ' htmldocs - HTML'
210 @echo ' pdfdocs - PDF'
211 @echo ' psdocs - Postscript'
212 @echo ' xmldocs - XML DocBook'
213 @echo ' mandocs - man pages'
214 @echo ' installmandocs - install man pages generated by mandocs'
215 @echo ' cleandocs - clean all generated DocBook files'
218 # Temporary files left by various tools
219 clean-files := $(DOCBOOKS) \
220 $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \
221 $(patsubst %.xml, %.aux, $(DOCBOOKS)) \
222 $(patsubst %.xml, %.tex, $(DOCBOOKS)) \
223 $(patsubst %.xml, %.log, $(DOCBOOKS)) \
224 $(patsubst %.xml, %.out, $(DOCBOOKS)) \
225 $(patsubst %.xml, %.ps, $(DOCBOOKS)) \
226 $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \
227 $(patsubst %.xml, %.html, $(DOCBOOKS)) \
228 $(patsubst %.xml, %.9, $(DOCBOOKS)) \
231 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
233 cleandocs: cleanmediadocs
234 $(Q)rm -f $(call objectify, $(clean-files))
235 $(Q)rm -rf $(call objectify, $(clean-dirs))
237 # Declare the contents of the .PHONY variable as phony. We keep that
238 # information in a variable se we can use it in if_changed and friends.