blob: 1462ed86d40aec28e0d54e947c93ad43f22333ae [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 \
Mark Brown9fe58172008-12-31 12:52:44 +000015 mac80211.xml debugobjects.xml sh.xml regulator.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -070016
17###
18# The build process is as follows (targets):
Randy Dunlap2ac534b2007-07-19 01:48:23 -070019# (xmldocs) [by docproc]
20# file.tmpl --> file.xml +--> file.ps (psdocs) [by db2ps or xmlto]
21# +--> file.pdf (pdfdocs) [by db2pdf or xmlto]
22# +--> DIR=file (htmldocs) [by xmlto]
23# +--> man/ (mandocs) [by xmlto]
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Martin Waitz71f95cf2005-11-13 16:08:15 -080025
26# for PDF and PS output you can choose between xmlto and docbook-utils tools
27PDF_METHOD = $(prefer-db2x)
28PS_METHOD = $(prefer-db2x)
29
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031###
32# The targets that may be used.
Paul Smith4f193362006-03-05 17:14:10 -050033PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
35BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
36xmldocs: $(BOOKS)
37sgmldocs: xmldocs
38
39PS := $(patsubst %.xml, %.ps, $(BOOKS))
40psdocs: $(PS)
41
42PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
43pdfdocs: $(PDF)
44
Randy Dunlapf15a3cc2007-04-11 08:44:12 -070045HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070046htmldocs: $(HTML)
Borislav Petkoveb81d932007-05-08 00:29:36 -070047 $(call build_main_index)
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49MAN := $(patsubst %.xml, %.9, $(BOOKS))
50mandocs: $(MAN)
51
52installmandocs: mandocs
Martin Waitz8b0c2d92005-05-01 08:59:27 -070053 mkdir -p /usr/local/man/man9/
54 install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56###
57#External programs used
Mike Frysinger829ad752006-12-29 16:49:07 -080058KERNELDOC = $(srctree)/scripts/kernel-doc
59DOCPROC = $(objtree)/scripts/basic/docproc
Martin Waitz8b0c2d92005-05-01 08:59:27 -070060
Jiri Slaby597f6ee2005-06-23 22:05:18 -070061XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
Martin Waitz2948e572005-05-01 08:59:27 -070062#XMLTOFLAGS += --skip-validation
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64###
65# DOCPROC is used for two purposes:
66# 1) To generate a dependency list for a .tmpl file
67# 2) To preprocess a .tmpl file and call kernel-doc with
68# appropriate parameters.
69# The following rules are used to generate the .xml documentation
70# required to generate the final targets. (ps, pdf, html).
71quiet_cmd_docproc = DOCPROC $@
72 cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
73define rule_docproc
74 set -e; \
75 $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \
76 $(cmd_$(1)); \
77 ( \
78 echo 'cmd_$@ := $(cmd_$(1))'; \
79 echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
80 ) > $(dir $@).$(notdir $@).cmd
81endef
82
83%.xml: %.tmpl FORCE
84 $(call if_changed_rule,docproc)
85
86###
87#Read in all saved dependency files
88cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
89
90ifneq ($(cmd_files),)
91 include $(cmd_files)
92endif
93
94###
95# Changes in kernel-doc force a rebuild of all documentation
96$(BOOKS): $(KERNELDOC)
97
98###
99# procfs guide uses a .c file as example code.
100# This requires an explicit dependency
101C-procfs-example = procfs_example.xml
102C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
103$(obj)/procfs-guide.xml: $(C-procfs-example2)
104
Randy Dunlap3794f3e2008-08-12 15:09:06 -0700105# List of programs to build
106##oops, this is a kernel module::hostprogs-y := procfs_example
107obj-m += procfs_example.o
108
109# Tell kbuild to always build the programs
110always := $(hostprogs-y)
111
Martin Waitz71f95cf2005-11-13 16:08:15 -0800112notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
113 exit 1
114db2xtemplate = db2TYPE -o $(dir $@) $<
115xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Martin Waitz71f95cf2005-11-13 16:08:15 -0800117# determine which methods are available
118ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
119 use-db2x = db2x
120 prefer-db2x = db2x
121else
122 use-db2x = notfound
123 prefer-db2x = $(use-xmlto)
124endif
125ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
126 use-xmlto = xmlto
127 prefer-xmlto = xmlto
128else
129 use-xmlto = notfound
130 prefer-xmlto = $(use-db2x)
131endif
132
133# the commands, generated from the chosen template
134quiet_cmd_db2ps = PS $@
135 cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136%.ps : %.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 $(call cmd,db2ps)
138
Hans Ulrich Niedermanna34645f2008-10-29 14:00:57 -0700139quiet_cmd_db2pdf = PDF $@
Martin Waitz71f95cf2005-11-13 16:08:15 -0800140 cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141%.pdf : %.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 $(call cmd,db2pdf)
143
Borislav Petkoveb81d932007-05-08 00:29:36 -0700144
145main_idx = Documentation/DocBook/index.html
146build_main_index = rm -rf $(main_idx) && \
147 echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
148 echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
149 cat $(HTML) >> $(main_idx)
150
Hans Ulrich Niedermanna34645f2008-10-29 14:00:57 -0700151quiet_cmd_db2html = HTML $@
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700152 cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
Martin Waitz4fa35162005-05-01 08:59:28 -0700153 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
Borislav Petkoveb81d932007-05-08 00:29:36 -0700154 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156%.html: %.xml
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700157 @(which xmlto > /dev/null 2>&1) || \
Sam Ravnborgfd4a3242005-05-01 08:59:28 -0700158 (echo "*** You need to install xmlto ***"; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 exit 1)
160 @rm -rf $@ $(patsubst %.html,%,$@)
161 $(call cmd,db2html)
162 @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
163 cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
164
Martin Waitz71f95cf2005-11-13 16:08:15 -0800165quiet_cmd_db2man = MAN $@
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700166 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
167%.9 : %.xml
168 @(which xmlto > /dev/null 2>&1) || \
Sam Ravnborgfd4a3242005-05-01 08:59:28 -0700169 (echo "*** You need to install xmlto ***"; \
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700170 exit 1)
Sam Ravnborge711db32007-04-13 23:07:00 +0200171 $(Q)mkdir -p $(obj)/man
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700172 $(call cmd,db2man)
173 @touch $@
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175###
Simon Arlott0f035b82007-10-20 01:30:25 +0200176# Rules to generate postscripts and PNG images from .fig format files
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177quiet_cmd_fig2eps = FIG2EPS $@
178 cmd_fig2eps = fig2dev -Leps $< $@
179
180%.eps: %.fig
181 @(which fig2dev > /dev/null 2>&1) || \
182 (echo "*** You need to install transfig ***"; \
183 exit 1)
184 $(call cmd,fig2eps)
185
186quiet_cmd_fig2png = FIG2PNG $@
187 cmd_fig2png = fig2dev -Lpng $< $@
188
189%.png: %.fig
190 @(which fig2dev > /dev/null 2>&1) || \
191 (echo "*** You need to install transfig ***"; \
192 exit 1)
193 $(call cmd,fig2png)
194
195###
196# Rule to convert a .c file to inline XML documentation
Mike Frysinger759cd602008-03-28 14:30:58 -0700197 gen_xml = :
198 quiet_gen_xml = echo ' GEN $@'
199silent_gen_xml = :
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200%.xml: %.c
Mike Frysinger759cd602008-03-28 14:30:58 -0700201 @$($(quiet)gen_xml)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 @( \
203 echo "<programlisting>"; \
204 expand --tabs=8 < $< | \
205 sed -e "s/&/\\&amp;/g" \
206 -e "s/</\\&lt;/g" \
207 -e "s/>/\\&gt;/g"; \
208 echo "</programlisting>") > $@
209
210###
211# Help targets as used by the top-level makefile
212dochelp:
Jesper Juhl6fc52f82006-12-07 00:16:26 +0100213 @echo ' Linux kernel internal documentation in different formats:'
214 @echo ' htmldocs - HTML'
215 @echo ' installmandocs - install man pages generated by mandocs'
216 @echo ' mandocs - man pages'
217 @echo ' pdfdocs - PDF'
218 @echo ' psdocs - Postscript'
219 @echo ' xmldocs - XML DocBook'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221###
222# Temporary files left by various tools
223clean-files := $(DOCBOOKS) \
224 $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \
225 $(patsubst %.xml, %.aux, $(DOCBOOKS)) \
226 $(patsubst %.xml, %.tex, $(DOCBOOKS)) \
227 $(patsubst %.xml, %.log, $(DOCBOOKS)) \
228 $(patsubst %.xml, %.out, $(DOCBOOKS)) \
229 $(patsubst %.xml, %.ps, $(DOCBOOKS)) \
230 $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \
231 $(patsubst %.xml, %.html, $(DOCBOOKS)) \
232 $(patsubst %.xml, %.9, $(DOCBOOKS)) \
233 $(C-procfs-example)
234
Sam Ravnborge711db32007-04-13 23:07:00 +0200235clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
Paul Smith4f193362006-03-05 17:14:10 -0500236
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.
239
240.PHONY: $(PHONY)