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 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)
53 $(call install_media_images)
55 MAN := $(patsubst %.xml, %.9, $(BOOKS))
58 installmandocs: mandocs
59 mkdir -p /usr/local/man/man9/
60 install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
63 #External programs used
64 KERNELDOC = $(srctree)/scripts/kernel-doc
65 DOCPROC = $(objtree)/scripts/docproc
67 XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
68 XMLTOFLAGS += --skip-validation
71 # DOCPROC is used for two purposes:
72 # 1) To generate a dependency list for a .tmpl file
73 # 2) To preprocess a .tmpl file and call kernel-doc with
74 # appropriate parameters.
75 # The following rules are used to generate the .xml documentation
76 # required to generate the final targets. (ps, pdf, html).
77 quiet_cmd_docproc = DOCPROC $@
78 cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
81 $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \
84 echo 'cmd_$@ := $(cmd_$(1))'; \
85 echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
86 ) > $(dir $@).$(notdir $@).cmd
90 $(call if_changed_rule,docproc)
93 #Read in all saved dependency files
94 cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
101 # Changes in kernel-doc force a rebuild of all documentation
102 $(BOOKS): $(KERNELDOC)
104 # Tell kbuild to always build the programs
105 always := $(hostprogs-y)
107 notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
109 db2xtemplate = db2TYPE -o $(dir $@) $<
110 xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
112 # determine which methods are available
113 ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
118 prefer-db2x = $(use-xmlto)
120 ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
125 prefer-xmlto = $(use-db2x)
128 # the commands, generated from the chosen template
129 quiet_cmd_db2ps = PS $@
130 cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
134 quiet_cmd_db2pdf = PDF $@
135 cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
141 main_idx = Documentation/DocBook/$(index)
142 build_main_index = rm -rf $(main_idx); \
143 echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
144 echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
145 cat $(HTML) >> $(main_idx)
147 quiet_cmd_db2html = HTML $@
148 cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
149 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
150 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
153 @(which xmlto > /dev/null 2>&1) || \
154 (echo "*** You need to install xmlto ***"; \
156 @rm -rf $@ $(patsubst %.html,%,$@)
158 @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
159 cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
161 quiet_cmd_db2man = MAN $@
162 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
164 @(which xmlto > /dev/null 2>&1) || \
165 (echo "*** You need to install xmlto ***"; \
167 $(Q)mkdir -p $(obj)/man
172 # Rules to generate postscripts and PNG images from .fig format files
173 quiet_cmd_fig2eps = FIG2EPS $@
174 cmd_fig2eps = fig2dev -Leps $< $@
177 @(which fig2dev > /dev/null 2>&1) || \
178 (echo "*** You need to install transfig ***"; \
182 quiet_cmd_fig2png = FIG2PNG $@
183 cmd_fig2png = fig2dev -Lpng $< $@
186 @(which fig2dev > /dev/null 2>&1) || \
187 (echo "*** You need to install transfig ***"; \
192 # Rule to convert a .c file to inline XML documentation
194 quiet_gen_xml = echo ' GEN $@'
199 echo "<programlisting>"; \
200 expand --tabs=8 < $< | \
201 sed -e "s/&/\\&/g" \
204 echo "</programlisting>") > $@
207 # Help targets as used by the top-level makefile
209 @echo ' Linux kernel internal documentation in different formats:'
210 @echo ' htmldocs - HTML'
211 @echo ' pdfdocs - PDF'
212 @echo ' psdocs - Postscript'
213 @echo ' xmldocs - XML DocBook'
214 @echo ' mandocs - man pages'
215 @echo ' installmandocs - install man pages generated by mandocs'
216 @echo ' cleandocs - clean all generated DocBook files'
219 # Temporary files left by various tools
220 clean-files := $(DOCBOOKS) \
221 $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \
222 $(patsubst %.xml, %.aux, $(DOCBOOKS)) \
223 $(patsubst %.xml, %.tex, $(DOCBOOKS)) \
224 $(patsubst %.xml, %.log, $(DOCBOOKS)) \
225 $(patsubst %.xml, %.out, $(DOCBOOKS)) \
226 $(patsubst %.xml, %.ps, $(DOCBOOKS)) \
227 $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \
228 $(patsubst %.xml, %.html, $(DOCBOOKS)) \
229 $(patsubst %.xml, %.9, $(DOCBOOKS)) \
232 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
234 cleandocs: cleanmediadocs
235 $(Q)rm -f $(call objectify, $(clean-files))
236 $(Q)rm -rf $(call objectify, $(clean-dirs))
238 # Declare the contents of the .PHONY variable as phony. We keep that
239 # information in a variable se we can use it in if_changed and friends.