blob: 22bbf7e390181428846e30827b00967cdbf72611 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001###
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
Adrian Bunk58ef2c42006-04-01 01:04:59 +02005# to document the SRC - and how to read it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07006# To add a new book the only step required is to add the book to the
7# list of DOCBOOKS.
8
Randy Dunlapf7f84f32009-02-22 12:15:45 -08009DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
Jeff Garzikac9296f2005-05-01 08:59:27 -070010 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
Randy Dunlapbc2cda12008-02-13 15:03:25 -080011 procfs-guide.xml writing_usb_driver.xml networking.xml \
Jason Wessele3e2aaf2008-03-20 13:43:45 -050012 kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
Thomas Gleixner11c869e2006-06-29 02:24:47 -070013 gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
Johannes Bergdbbea672008-02-26 14:34:06 +010014 genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
Randy Dunlape776ec12009-02-28 17:40:18 +010015 mac80211.xml debugobjects.xml sh.xml regulator.xml \
Jason Barona76f8c62009-04-30 13:29:42 -040016 alsa-driver-api.xml writing-an-alsa-driver.xml \
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030017 tracepoint.xml media.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -070018
19###
20# The build process is as follows (targets):
Randy Dunlap2ac534b2007-07-19 01:48:23 -070021# (xmldocs) [by docproc]
22# file.tmpl --> file.xml +--> file.ps (psdocs) [by db2ps or xmlto]
23# +--> file.pdf (pdfdocs) [by db2pdf or xmlto]
24# +--> DIR=file (htmldocs) [by xmlto]
25# +--> man/ (mandocs) [by xmlto]
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
Martin Waitz71f95cf2005-11-13 16:08:15 -080027
28# for PDF and PS output you can choose between xmlto and docbook-utils tools
29PDF_METHOD = $(prefer-db2x)
30PS_METHOD = $(prefer-db2x)
31
32
Linus Torvalds1da177e2005-04-16 15:20:36 -070033###
34# The targets that may be used.
Ben Hutchings49b14652009-12-03 19:50:35 -030035PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
37BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
38xmldocs: $(BOOKS)
39sgmldocs: xmldocs
40
41PS := $(patsubst %.xml, %.ps, $(BOOKS))
42psdocs: $(PS)
43
44PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
45pdfdocs: $(PDF)
46
Randy Dunlapf15a3cc2007-04-11 08:44:12 -070047HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
Ben Hutchings49b14652009-12-03 19:50:35 -030048htmldocs: $(HTML)
Borislav Petkoveb81d932007-05-08 00:29:36 -070049 $(call build_main_index)
Ben Hutchings49b14652009-12-03 19:50:35 -030050 $(call build_images)
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52MAN := $(patsubst %.xml, %.9, $(BOOKS))
53mandocs: $(MAN)
54
Ben Hutchings49b14652009-12-03 19:50:35 -030055build_images = mkdir -p $(objtree)/Documentation/DocBook/media/ && \
56 cp $(srctree)/Documentation/DocBook/dvb/*.png $(srctree)/Documentation/DocBook/v4l/*.gif $(objtree)/Documentation/DocBook/media/
Mauro Carvalho Chehab7ac94052009-09-15 18:46:15 -030057
Linus Torvalds1da177e2005-04-16 15:20:36 -070058installmandocs: mandocs
Martin Waitz8b0c2d92005-05-01 08:59:27 -070059 mkdir -p /usr/local/man/man9/
60 install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62###
63#External programs used
Mike Frysinger829ad752006-12-29 16:49:07 -080064KERNELDOC = $(srctree)/scripts/kernel-doc
65DOCPROC = $(objtree)/scripts/basic/docproc
Martin Waitz8b0c2d92005-05-01 08:59:27 -070066
Jiri Slaby597f6ee2005-06-23 22:05:18 -070067XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
Martin Waitz2948e572005-05-01 08:59:27 -070068#XMLTOFLAGS += --skip-validation
Linus Torvalds1da177e2005-04-16 15:20:36 -070069
70###
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).
77quiet_cmd_docproc = DOCPROC $@
78 cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
79define rule_docproc
80 set -e; \
81 $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \
82 $(cmd_$(1)); \
83 ( \
84 echo 'cmd_$@ := $(cmd_$(1))'; \
85 echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
86 ) > $(dir $@).$(notdir $@).cmd
87endef
88
89%.xml: %.tmpl FORCE
90 $(call if_changed_rule,docproc)
91
92###
93#Read in all saved dependency files
94cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
95
96ifneq ($(cmd_files),)
97 include $(cmd_files)
98endif
99
100###
101# Changes in kernel-doc force a rebuild of all documentation
102$(BOOKS): $(KERNELDOC)
103
104###
105# procfs guide uses a .c file as example code.
106# This requires an explicit dependency
107C-procfs-example = procfs_example.xml
108C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
109$(obj)/procfs-guide.xml: $(C-procfs-example2)
110
Randy Dunlap3794f3e2008-08-12 15:09:06 -0700111# List of programs to build
112##oops, this is a kernel module::hostprogs-y := procfs_example
113obj-m += procfs_example.o
114
115# Tell kbuild to always build the programs
116always := $(hostprogs-y)
117
Martin Waitz71f95cf2005-11-13 16:08:15 -0800118notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
119 exit 1
120db2xtemplate = db2TYPE -o $(dir $@) $<
121xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122
Martin Waitz71f95cf2005-11-13 16:08:15 -0800123# determine which methods are available
124ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
125 use-db2x = db2x
126 prefer-db2x = db2x
127else
128 use-db2x = notfound
129 prefer-db2x = $(use-xmlto)
130endif
131ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
132 use-xmlto = xmlto
133 prefer-xmlto = xmlto
134else
135 use-xmlto = notfound
136 prefer-xmlto = $(use-db2x)
137endif
138
139# the commands, generated from the chosen template
140quiet_cmd_db2ps = PS $@
141 cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142%.ps : %.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 $(call cmd,db2ps)
144
Hans Ulrich Niedermanna34645f2008-10-29 14:00:57 -0700145quiet_cmd_db2pdf = PDF $@
Martin Waitz71f95cf2005-11-13 16:08:15 -0800146 cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147%.pdf : %.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 $(call cmd,db2pdf)
149
Borislav Petkoveb81d932007-05-08 00:29:36 -0700150
Randy Dunlap64e3da12009-04-17 18:28:55 -0700151index = index.html
152main_idx = Documentation/DocBook/$(index)
Borislav Petkoveb81d932007-05-08 00:29:36 -0700153build_main_index = rm -rf $(main_idx) && \
154 echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
155 echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
156 cat $(HTML) >> $(main_idx)
157
Hans Ulrich Niedermanna34645f2008-10-29 14:00:57 -0700158quiet_cmd_db2html = HTML $@
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700159 cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
Martin Waitz4fa35162005-05-01 08:59:28 -0700160 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
Borislav Petkoveb81d932007-05-08 00:29:36 -0700161 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
163%.html: %.xml
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700164 @(which xmlto > /dev/null 2>&1) || \
Sam Ravnborgfd4a3242005-05-01 08:59:28 -0700165 (echo "*** You need to install xmlto ***"; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 exit 1)
167 @rm -rf $@ $(patsubst %.html,%,$@)
168 $(call cmd,db2html)
169 @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
170 cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
171
Martin Waitz71f95cf2005-11-13 16:08:15 -0800172quiet_cmd_db2man = MAN $@
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700173 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
174%.9 : %.xml
175 @(which xmlto > /dev/null 2>&1) || \
Sam Ravnborgfd4a3242005-05-01 08:59:28 -0700176 (echo "*** You need to install xmlto ***"; \
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700177 exit 1)
Sam Ravnborge711db32007-04-13 23:07:00 +0200178 $(Q)mkdir -p $(obj)/man
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700179 $(call cmd,db2man)
180 @touch $@
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
182###
Simon Arlott0f035b82007-10-20 01:30:25 +0200183# Rules to generate postscripts and PNG images from .fig format files
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184quiet_cmd_fig2eps = FIG2EPS $@
185 cmd_fig2eps = fig2dev -Leps $< $@
186
187%.eps: %.fig
188 @(which fig2dev > /dev/null 2>&1) || \
189 (echo "*** You need to install transfig ***"; \
190 exit 1)
191 $(call cmd,fig2eps)
192
193quiet_cmd_fig2png = FIG2PNG $@
194 cmd_fig2png = fig2dev -Lpng $< $@
195
196%.png: %.fig
197 @(which fig2dev > /dev/null 2>&1) || \
198 (echo "*** You need to install transfig ***"; \
199 exit 1)
200 $(call cmd,fig2png)
201
202###
203# Rule to convert a .c file to inline XML documentation
Mike Frysinger759cd602008-03-28 14:30:58 -0700204 gen_xml = :
205 quiet_gen_xml = echo ' GEN $@'
206silent_gen_xml = :
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207%.xml: %.c
Mike Frysinger759cd602008-03-28 14:30:58 -0700208 @$($(quiet)gen_xml)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209 @( \
210 echo "<programlisting>"; \
211 expand --tabs=8 < $< | \
212 sed -e "s/&/\\&amp;/g" \
213 -e "s/</\\&lt;/g" \
214 -e "s/>/\\&gt;/g"; \
215 echo "</programlisting>") > $@
216
217###
218# Help targets as used by the top-level makefile
219dochelp:
Jesper Juhl6fc52f82006-12-07 00:16:26 +0100220 @echo ' Linux kernel internal documentation in different formats:'
221 @echo ' htmldocs - HTML'
Jesper Juhl6fc52f82006-12-07 00:16:26 +0100222 @echo ' pdfdocs - PDF'
223 @echo ' psdocs - Postscript'
224 @echo ' xmldocs - XML DocBook'
Randy Dunlap2810ae82009-04-10 14:20:54 -0700225 @echo ' mandocs - man pages'
226 @echo ' installmandocs - install man pages generated by mandocs'
227 @echo ' cleandocs - clean all generated DocBook files'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228
229###
230# Temporary files left by various tools
231clean-files := $(DOCBOOKS) \
232 $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \
233 $(patsubst %.xml, %.aux, $(DOCBOOKS)) \
234 $(patsubst %.xml, %.tex, $(DOCBOOKS)) \
235 $(patsubst %.xml, %.log, $(DOCBOOKS)) \
236 $(patsubst %.xml, %.out, $(DOCBOOKS)) \
237 $(patsubst %.xml, %.ps, $(DOCBOOKS)) \
238 $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \
239 $(patsubst %.xml, %.html, $(DOCBOOKS)) \
240 $(patsubst %.xml, %.9, $(DOCBOOKS)) \
Randy Dunlap64e3da12009-04-17 18:28:55 -0700241 $(C-procfs-example) $(index)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Sam Ravnborge711db32007-04-13 23:07:00 +0200243clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
Paul Smith4f193362006-03-05 17:14:10 -0500244
Randy Dunlap2810ae82009-04-10 14:20:54 -0700245cleandocs:
246 $(Q)rm -f $(call objectify, $(clean-files))
247 $(Q)rm -rf $(call objectify, $(clean-dirs))
248
Paul Smith4f193362006-03-05 17:14:10 -0500249# Declare the contents of the .PHONY variable as phony. We keep that
250# information in a variable se we can use it in if_changed and friends.
251
252.PHONY: $(PHONY)