Merge branch 'irq-core-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6.git] / Documentation / DocBook / Makefile
1 ###
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
7 # list of DOCBOOKS.
8
9 DOCBOOKS := z8530book.xml mcabook.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 media.xml drm.xml
18
19 ###
20 # The build process is as follows (targets):
21 #              (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]
26
27
28 # for PDF and PS output you can choose between xmlto and docbook-utils tools
29 PDF_METHOD      = $(prefer-db2x)
30 PS_METHOD       = $(prefer-db2x)
31
32
33 ###
34 # The targets that may be used.
35 PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs xmldoclinks
36
37 BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
38 xmldocs: $(BOOKS)
39 sgmldocs: xmldocs
40
41 PS := $(patsubst %.xml, %.ps, $(BOOKS))
42 psdocs: $(PS)
43
44 PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
45 pdfdocs: $(PDF)
46
47 HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
48 htmldocs: $(HTML) xmldoclinks
49         $(call build_main_index)
50         $(call build_images)
51
52 MAN := $(patsubst %.xml, %.9, $(BOOKS))
53 mandocs: $(MAN)
54
55 build_images = mkdir -p $(objtree)/Documentation/DocBook/media/ && \
56                cp $(srctree)/Documentation/DocBook/dvb/*.png \
57                   $(srctree)/Documentation/DocBook/v4l/*.gif \
58                   $(objtree)/Documentation/DocBook/media/
59
60 xmldoclinks:
61 ifneq ($(objtree),$(srctree))
62         for dep in dvb media-entities.tmpl media-indices.tmpl v4l; do \
63                 rm -f $(objtree)/Documentation/DocBook/$$dep \
64                 && ln -s $(srctree)/Documentation/DocBook/$$dep $(objtree)/Documentation/DocBook/ \
65                 || exit; \
66         done
67 endif
68
69 installmandocs: mandocs
70         mkdir -p /usr/local/man/man9/
71         install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
72
73 ###
74 #External programs used
75 KERNELDOC = $(srctree)/scripts/kernel-doc
76 DOCPROC   = $(objtree)/scripts/basic/docproc
77
78 XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
79 XMLTOFLAGS += --skip-validation
80
81 ###
82 # DOCPROC is used for two purposes:
83 # 1) To generate a dependency list for a .tmpl file
84 # 2) To preprocess a .tmpl file and call kernel-doc with
85 #     appropriate parameters.
86 # The following rules are used to generate the .xml documentation
87 # required to generate the final targets. (ps, pdf, html).
88 quiet_cmd_docproc = DOCPROC $@
89       cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
90 define rule_docproc
91         set -e;                                                         \
92         $(if $($(quiet)cmd_$(1)),echo '  $($(quiet)cmd_$(1))';)         \
93         $(cmd_$(1));                                                    \
94         (                                                               \
95           echo 'cmd_$@ := $(cmd_$(1))';                                 \
96           echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`;           \
97         ) > $(dir $@).$(notdir $@).cmd
98 endef
99
100 %.xml: %.tmpl xmldoclinks FORCE
101         $(call if_changed_rule,docproc)
102
103 ###
104 #Read in all saved dependency files 
105 cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
106
107 ifneq ($(cmd_files),)
108   include $(cmd_files)
109 endif
110
111 ###
112 # Changes in kernel-doc force a rebuild of all documentation
113 $(BOOKS): $(KERNELDOC)
114
115 # Tell kbuild to always build the programs
116 always := $(hostprogs-y)
117
118 notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
119                    exit 1
120 db2xtemplate = db2TYPE -o $(dir $@) $<
121 xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
122
123 # determine which methods are available
124 ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
125         use-db2x = db2x
126         prefer-db2x = db2x
127 else
128         use-db2x = notfound
129         prefer-db2x = $(use-xmlto)
130 endif
131 ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
132         use-xmlto = xmlto
133         prefer-xmlto = xmlto
134 else
135         use-xmlto = notfound
136         prefer-xmlto = $(use-db2x)
137 endif
138
139 # the commands, generated from the chosen template
140 quiet_cmd_db2ps = PS      $@
141       cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
142 %.ps : %.xml
143         $(call cmd,db2ps)
144
145 quiet_cmd_db2pdf = PDF     $@
146       cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
147 %.pdf : %.xml
148         $(call cmd,db2pdf)
149
150
151 index = index.html
152 main_idx = Documentation/DocBook/$(index)
153 build_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
158 quiet_cmd_db2html = HTML    $@
159       cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
160                 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
161         $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
162
163 %.html: %.xml
164         @(which xmlto > /dev/null 2>&1) || \
165          (echo "*** You need to install xmlto ***"; \
166           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
172 quiet_cmd_db2man = MAN     $@
173       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) || \
176          (echo "*** You need to install xmlto ***"; \
177           exit 1)
178         $(Q)mkdir -p $(obj)/man
179         $(call cmd,db2man)
180         @touch $@
181
182 ###
183 # Rules to generate postscripts and PNG images from .fig format files
184 quiet_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
193 quiet_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
204        gen_xml = :
205  quiet_gen_xml = echo '  GEN     $@'
206 silent_gen_xml = :
207 %.xml: %.c
208         @$($(quiet)gen_xml)
209         @(                            \
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
219 dochelp:
220         @echo  ' Linux kernel internal documentation in different formats:'
221         @echo  '  htmldocs        - HTML'
222         @echo  '  pdfdocs         - PDF'
223         @echo  '  psdocs          - Postscript'
224         @echo  '  xmldocs         - XML DocBook'
225         @echo  '  mandocs         - man pages'
226         @echo  '  installmandocs  - install man pages generated by mandocs'
227         @echo  '  cleandocs       - clean all generated DocBook files'
228
229 ###
230 # Temporary files left by various tools
231 clean-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)) \
241         $(index)
242
243 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
244
245 cleandocs:
246         $(Q)rm -f $(call objectify, $(clean-files))
247         $(Q)rm -rf $(call objectify, $(clean-dirs))
248
249 # 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)