blob: 6fd1646d3204d8b17555ac436667b5ffe1b9de95 [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
9DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \
Jeff Garzikac9296f2005-05-01 08:59:27 -070010 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
James Bottomleyad34ea22005-05-20 15:27:44 -050011 procfs-guide.xml writing_usb_driver.xml \
Randy Dunlap733b72c2006-11-02 22:07:02 -080012 kernel-api.xml filesystems.xml lsm.xml usb.xml \
Thomas Gleixner11c869e2006-06-29 02:24:47 -070013 gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
14 genericirq.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
16###
17# The build process is as follows (targets):
18# (xmldocs)
19# file.tmpl --> file.xml +--> file.ps (psdocs)
20# +--> file.pdf (pdfdocs)
21# +--> DIR=file (htmldocs)
22# +--> man/ (mandocs)
23
Martin Waitz71f95cf2005-11-13 16:08:15 -080024
25# for PDF and PS output you can choose between xmlto and docbook-utils tools
26PDF_METHOD = $(prefer-db2x)
27PS_METHOD = $(prefer-db2x)
28
29
Linus Torvalds1da177e2005-04-16 15:20:36 -070030###
31# The targets that may be used.
Paul Smith4f193362006-03-05 17:14:10 -050032PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs
Linus Torvalds1da177e2005-04-16 15:20:36 -070033
34BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
35xmldocs: $(BOOKS)
36sgmldocs: xmldocs
37
38PS := $(patsubst %.xml, %.ps, $(BOOKS))
39psdocs: $(PS)
40
41PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
42pdfdocs: $(PDF)
43
Randy Dunlapf15a3cc2007-04-11 08:44:12 -070044HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
Linus Torvalds1da177e2005-04-16 15:20:36 -070045htmldocs: $(HTML)
Borislav Petkoveb81d932007-05-08 00:29:36 -070046 $(call build_main_index)
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48MAN := $(patsubst %.xml, %.9, $(BOOKS))
49mandocs: $(MAN)
50
51installmandocs: mandocs
Martin Waitz8b0c2d92005-05-01 08:59:27 -070052 mkdir -p /usr/local/man/man9/
53 install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55###
56#External programs used
Mike Frysinger829ad752006-12-29 16:49:07 -080057KERNELDOC = $(srctree)/scripts/kernel-doc
58DOCPROC = $(objtree)/scripts/basic/docproc
Martin Waitz8b0c2d92005-05-01 08:59:27 -070059
Jiri Slaby597f6ee2005-06-23 22:05:18 -070060XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
Martin Waitz2948e572005-05-01 08:59:27 -070061#XMLTOFLAGS += --skip-validation
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63###
64# DOCPROC is used for two purposes:
65# 1) To generate a dependency list for a .tmpl file
66# 2) To preprocess a .tmpl file and call kernel-doc with
67# appropriate parameters.
68# The following rules are used to generate the .xml documentation
69# required to generate the final targets. (ps, pdf, html).
70quiet_cmd_docproc = DOCPROC $@
71 cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
72define rule_docproc
73 set -e; \
74 $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \
75 $(cmd_$(1)); \
76 ( \
77 echo 'cmd_$@ := $(cmd_$(1))'; \
78 echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
79 ) > $(dir $@).$(notdir $@).cmd
80endef
81
82%.xml: %.tmpl FORCE
83 $(call if_changed_rule,docproc)
84
85###
86#Read in all saved dependency files
87cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
88
89ifneq ($(cmd_files),)
90 include $(cmd_files)
91endif
92
93###
94# Changes in kernel-doc force a rebuild of all documentation
95$(BOOKS): $(KERNELDOC)
96
97###
98# procfs guide uses a .c file as example code.
99# This requires an explicit dependency
100C-procfs-example = procfs_example.xml
101C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
102$(obj)/procfs-guide.xml: $(C-procfs-example2)
103
Martin Waitz71f95cf2005-11-13 16:08:15 -0800104notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
105 exit 1
106db2xtemplate = db2TYPE -o $(dir $@) $<
107xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
Martin Waitz71f95cf2005-11-13 16:08:15 -0800109# determine which methods are available
110ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
111 use-db2x = db2x
112 prefer-db2x = db2x
113else
114 use-db2x = notfound
115 prefer-db2x = $(use-xmlto)
116endif
117ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
118 use-xmlto = xmlto
119 prefer-xmlto = xmlto
120else
121 use-xmlto = notfound
122 prefer-xmlto = $(use-db2x)
123endif
124
125# the commands, generated from the chosen template
126quiet_cmd_db2ps = PS $@
127 cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128%.ps : %.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 $(call cmd,db2ps)
130
Martin Waitz71f95cf2005-11-13 16:08:15 -0800131quiet_cmd_db2pdf = PDF $@
132 cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133%.pdf : %.xml
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 $(call cmd,db2pdf)
135
Borislav Petkoveb81d932007-05-08 00:29:36 -0700136
137main_idx = Documentation/DocBook/index.html
138build_main_index = rm -rf $(main_idx) && \
139 echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
140 echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
141 cat $(HTML) >> $(main_idx)
142
Martin Waitz71f95cf2005-11-13 16:08:15 -0800143quiet_cmd_db2html = HTML $@
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700144 cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
Martin Waitz4fa35162005-05-01 08:59:28 -0700145 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
Borislav Petkoveb81d932007-05-08 00:29:36 -0700146 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
148%.html: %.xml
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700149 @(which xmlto > /dev/null 2>&1) || \
Sam Ravnborgfd4a3242005-05-01 08:59:28 -0700150 (echo "*** You need to install xmlto ***"; \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 exit 1)
152 @rm -rf $@ $(patsubst %.html,%,$@)
153 $(call cmd,db2html)
154 @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
155 cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
156
Martin Waitz71f95cf2005-11-13 16:08:15 -0800157quiet_cmd_db2man = MAN $@
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700158 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
159%.9 : %.xml
160 @(which xmlto > /dev/null 2>&1) || \
Sam Ravnborgfd4a3242005-05-01 08:59:28 -0700161 (echo "*** You need to install xmlto ***"; \
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700162 exit 1)
Sam Ravnborge711db32007-04-13 23:07:00 +0200163 $(Q)mkdir -p $(obj)/man
Martin Waitz8b0c2d92005-05-01 08:59:27 -0700164 $(call cmd,db2man)
165 @touch $@
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166
167###
168# Rules to generate postscripts and PNG imgages from .fig format files
169quiet_cmd_fig2eps = FIG2EPS $@
170 cmd_fig2eps = fig2dev -Leps $< $@
171
172%.eps: %.fig
173 @(which fig2dev > /dev/null 2>&1) || \
174 (echo "*** You need to install transfig ***"; \
175 exit 1)
176 $(call cmd,fig2eps)
177
178quiet_cmd_fig2png = FIG2PNG $@
179 cmd_fig2png = fig2dev -Lpng $< $@
180
181%.png: %.fig
182 @(which fig2dev > /dev/null 2>&1) || \
183 (echo "*** You need to install transfig ***"; \
184 exit 1)
185 $(call cmd,fig2png)
186
187###
188# Rule to convert a .c file to inline XML documentation
189%.xml: %.c
190 @echo ' GEN $@'
191 @( \
192 echo "<programlisting>"; \
193 expand --tabs=8 < $< | \
194 sed -e "s/&/\\&amp;/g" \
195 -e "s/</\\&lt;/g" \
196 -e "s/>/\\&gt;/g"; \
197 echo "</programlisting>") > $@
198
199###
200# Help targets as used by the top-level makefile
201dochelp:
Jesper Juhl6fc52f82006-12-07 00:16:26 +0100202 @echo ' Linux kernel internal documentation in different formats:'
203 @echo ' htmldocs - HTML'
204 @echo ' installmandocs - install man pages generated by mandocs'
205 @echo ' mandocs - man pages'
206 @echo ' pdfdocs - PDF'
207 @echo ' psdocs - Postscript'
208 @echo ' xmldocs - XML DocBook'
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210###
211# Temporary files left by various tools
212clean-files := $(DOCBOOKS) \
213 $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \
214 $(patsubst %.xml, %.aux, $(DOCBOOKS)) \
215 $(patsubst %.xml, %.tex, $(DOCBOOKS)) \
216 $(patsubst %.xml, %.log, $(DOCBOOKS)) \
217 $(patsubst %.xml, %.out, $(DOCBOOKS)) \
218 $(patsubst %.xml, %.ps, $(DOCBOOKS)) \
219 $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \
220 $(patsubst %.xml, %.html, $(DOCBOOKS)) \
221 $(patsubst %.xml, %.9, $(DOCBOOKS)) \
222 $(C-procfs-example)
223
Sam Ravnborge711db32007-04-13 23:07:00 +0200224clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
Paul Smith4f193362006-03-05 17:14:10 -0500225
226# Declare the contents of the .PHONY variable as phony. We keep that
227# information in a variable se we can use it in if_changed and friends.
228
229.PHONY: $(PHONY)