blob: b444f2e8fe32b3818d45997ca7f80c883a8619bb [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
Paul Gortmakerbb8187d2012-05-17 19:06:13 -04009DOCBOOKS := z8530book.xml device-drivers.xml \
Jeff Garzikac9296f2005-05-01 08:59:27 -070010 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
Alexey Dobriyan82c1e492009-12-15 16:46:59 -080011 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 \
Johannes Berg352de5572010-08-17 12:04:34 +020015 80211.xml debugobjects.xml sh.xml regulator.xml \
Jason Barona76f8c62009-04-30 13:29:42 -040016 alsa-driver-api.xml writing-an-alsa-driver.xml \
David Friesb3be1772014-01-15 22:29:25 -060017 tracepoint.xml drm.xml media_api.xml w1.xml
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -030018
Kevin Haob12f7372014-04-01 14:36:10 +080019include Documentation/DocBook/media/Makefile
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
21###
22# The build process is as follows (targets):
Randy Dunlap2ac534b2007-07-19 01:48:23 -070023# (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]
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
Martin Waitz71f95cf2005-11-13 16:08:15 -080029
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070035###
36# The targets that may be used.
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -030037PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Masahiro Yamada6f89b9c2014-01-20 14:10:10 +090039targets += $(DOCBOOKS)
Linus Torvalds1da177e2005-04-16 15:20:36 -070040BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
Ben Hutchingsa4356002010-08-10 18:02:51 -070041xmldocs: $(BOOKS)
Linus Torvalds1da177e2005-04-16 15:20:36 -070042sgmldocs: xmldocs
43
44PS := $(patsubst %.xml, %.ps, $(BOOKS))
45psdocs: $(PS)
46
47PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
48pdfdocs: $(PDF)
49
Randy Dunlapf15a3cc2007-04-11 08:44:12 -070050HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
Mauro Carvalho Chehab04893042011-05-25 12:24:48 -030051htmldocs: $(HTML)
Borislav Petkoveb81d932007-05-08 00:29:36 -070052 $(call build_main_index)
Ben Hutchings49b14652009-12-03 19:50:35 -030053 $(call build_images)
Mauro Carvalho Chehabbd7319d2011-06-15 23:13:19 -030054 $(call install_media_images)
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56MAN := $(patsubst %.xml, %.9, $(BOOKS))
57mandocs: $(MAN)
Ben Hutchings832919b2013-11-06 13:18:30 -080058 $(if $(wildcard $(obj)/man/*.9),gzip -f $(obj)/man/*.9)
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60installmandocs: mandocs
Martin Waitz8b0c2d92005-05-01 08:59:27 -070061 mkdir -p /usr/local/man/man9/
Masahiro Yamadaec3fadd2014-03-18 15:47:13 +090062 install $(obj)/man/*.9.gz /usr/local/man/man9/
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64###
65#External programs used
Mike Frysinger829ad752006-12-29 16:49:07 -080066KERNELDOC = $(srctree)/scripts/kernel-doc
Peter Foleybffd2022011-05-02 22:48:03 +020067DOCPROC = $(objtree)/scripts/docproc
Martin Waitz8b0c2d92005-05-01 08:59:27 -070068
Masahiro Yamadaec3fadd2014-03-18 15:47:13 +090069XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl
Alexey Dobriyan82c1e492009-12-15 16:46:59 -080070XMLTOFLAGS += --skip-validation
Linus Torvalds1da177e2005-04-16 15:20:36 -070071
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
Masahiro Yamada100da4c2014-01-20 14:10:11 +090091%.xml: %.tmpl $(KERNELDOC) $(DOCPROC) FORCE
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 $(call if_changed_rule,docproc)
93
Randy Dunlap3794f3e2008-08-12 15:09:06 -070094# Tell kbuild to always build the programs
95always := $(hostprogs-y)
96
Martin Waitz71f95cf2005-11-13 16:08:15 -080097notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
98 exit 1
99db2xtemplate = db2TYPE -o $(dir $@) $<
100xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Martin Waitz71f95cf2005-11-13 16:08:15 -0800102# 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))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121%.ps : %.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 $(call cmd,db2ps)
123
Hans Ulrich Niedermanna34645f2008-10-29 14:00:57 -0700124quiet_cmd_db2pdf = PDF $@
Martin Waitz71f95cf2005-11-13 16:08:15 -0800125 cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126%.pdf : %.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 $(call cmd,db2pdf)
128
Borislav Petkoveb81d932007-05-08 00:29:36 -0700129
Randy Dunlap64e3da12009-04-17 18:28:55 -0700130index = index.html
Masahiro Yamadaec3fadd2014-03-18 15:47:13 +0900131main_idx = $(obj)/$(index)
Mauro Carvalho Chehab04893042011-05-25 12:24:48 -0300132build_main_index = rm -rf $(main_idx); \
Borislav Petkoveb81d932007-05-08 00:29:36 -0700133 echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
134 echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
135 cat $(HTML) >> $(main_idx)
136
Hans Ulrich Niedermanna34645f2008-10-29 14:00:57 -0700137quiet_cmd_db2html = HTML $@
Robert P. J. Dayc4d79a42013-11-06 13:18:27 -0800138 cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
Martin Waitz4fa35162005-05-01 08:59:28 -0700139 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
Masahiro Yamadaec3fadd2014-03-18 15:47:13 +0900140 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142%.html: %.xml
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700143 @(which xmlto > /dev/null 2>&1) || \
Sam Ravnborgfd4a3242005-05-01 08:59:28 -0700144 (echo "*** You need to install xmlto ***"; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 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
Martin Waitz71f95cf2005-11-13 16:08:15 -0800151quiet_cmd_db2man = MAN $@
Ben Hutchings832919b2013-11-06 13:18:30 -0800152 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; fi
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700153%.9 : %.xml
154 @(which xmlto > /dev/null 2>&1) || \
Sam Ravnborgfd4a3242005-05-01 08:59:28 -0700155 (echo "*** You need to install xmlto ***"; \
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700156 exit 1)
Sam Ravnborge711db32007-04-13 23:07:00 +0200157 $(Q)mkdir -p $(obj)/man
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700158 $(call cmd,db2man)
159 @touch $@
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
161###
Simon Arlott0f035b82007-10-20 01:30:25 +0200162# Rules to generate postscripts and PNG images from .fig format files
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163quiet_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
Mike Frysinger759cd602008-03-28 14:30:58 -0700183 gen_xml = :
184 quiet_gen_xml = echo ' GEN $@'
185silent_gen_xml = :
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186%.xml: %.c
Mike Frysinger759cd602008-03-28 14:30:58 -0700187 @$($(quiet)gen_xml)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 @( \
189 echo "<programlisting>"; \
190 expand --tabs=8 < $< | \
191 sed -e "s/&/\\&amp;/g" \
192 -e "s/</\\&lt;/g" \
193 -e "s/>/\\&gt;/g"; \
194 echo "</programlisting>") > $@
195
196###
197# Help targets as used by the top-level makefile
198dochelp:
Jesper Juhl6fc52f82006-12-07 00:16:26 +0100199 @echo ' Linux kernel internal documentation in different formats:'
200 @echo ' htmldocs - HTML'
Jesper Juhl6fc52f82006-12-07 00:16:26 +0100201 @echo ' pdfdocs - PDF'
202 @echo ' psdocs - Postscript'
203 @echo ' xmldocs - XML DocBook'
Randy Dunlap2810ae8c2009-04-10 14:20:54 -0700204 @echo ' mandocs - man pages'
205 @echo ' installmandocs - install man pages generated by mandocs'
206 @echo ' cleandocs - clean all generated DocBook files'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
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)) \
Alexey Dobriyan82c1e492009-12-15 16:46:59 -0800220 $(index)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -0300222clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
Paul Smith4f193362006-03-05 17:14:10 -0500223
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -0300224cleandocs: cleanmediadocs
Randy Dunlap2810ae8c2009-04-10 14:20:54 -0700225 $(Q)rm -f $(call objectify, $(clean-files))
226 $(Q)rm -rf $(call objectify, $(clean-dirs))
227
Paul Smith4f193362006-03-05 17:14:10 -0500228# 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)