[media] DocBook/dvbproperty.xml: Better name the ISDB-T layers
[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 drm.xml media_api.xml
18
19 include $(srctree)/Documentation/DocBook/media/Makefile
20
21 ###
22 # The build process is as follows (targets):
23 #              (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]
28
29
30 # for PDF and PS output you can choose between xmlto and docbook-utils tools
31 PDF_METHOD      = $(prefer-db2x)
32 PS_METHOD       = $(prefer-db2x)
33
34
35 ###
36 # The targets that may be used.
37 PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
38
39 BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
40 xmldocs: $(BOOKS)
41 sgmldocs: xmldocs
42
43 PS := $(patsubst %.xml, %.ps, $(BOOKS))
44 psdocs: $(PS)
45
46 PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
47 pdfdocs: $(PDF)
48
49 HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
50 htmldocs: $(HTML)
51         $(call build_main_index)
52         $(call build_images)
53
54 MAN := $(patsubst %.xml, %.9, $(BOOKS))
55 mandocs: $(MAN)
56
57 installmandocs: mandocs
58         mkdir -p /usr/local/man/man9/
59         install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
60
61 ###
62 #External programs used
63 KERNELDOC = $(srctree)/scripts/kernel-doc
64 DOCPROC   = $(objtree)/scripts/docproc
65
66 XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
67 XMLTOFLAGS += --skip-validation
68
69 ###
70 # DOCPROC is used for two purposes:
71 # 1) To generate a dependency list for a .tmpl file
72 # 2) To preprocess a .tmpl file and call kernel-doc with
73 #     appropriate parameters.
74 # The following rules are used to generate the .xml documentation
75 # required to generate the final targets. (ps, pdf, html).
76 quiet_cmd_docproc = DOCPROC $@
77       cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
78 define rule_docproc
79         set -e;                                                         \
80         $(if $($(quiet)cmd_$(1)),echo '  $($(quiet)cmd_$(1))';)         \
81         $(cmd_$(1));                                                    \
82         (                                                               \
83           echo 'cmd_$@ := $(cmd_$(1))';                                 \
84           echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`;           \
85         ) > $(dir $@).$(notdir $@).cmd
86 endef
87
88 %.xml: %.tmpl FORCE
89         $(call if_changed_rule,docproc)
90
91 ###
92 #Read in all saved dependency files
93 cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
94
95 ifneq ($(cmd_files),)
96   include $(cmd_files)
97 endif
98
99 ###
100 # Changes in kernel-doc force a rebuild of all documentation
101 $(BOOKS): $(KERNELDOC)
102
103 # Tell kbuild to always build the programs
104 always := $(hostprogs-y)
105
106 notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
107                    exit 1
108 db2xtemplate = db2TYPE -o $(dir $@) $<
109 xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
110
111 # determine which methods are available
112 ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
113         use-db2x = db2x
114         prefer-db2x = db2x
115 else
116         use-db2x = notfound
117         prefer-db2x = $(use-xmlto)
118 endif
119 ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
120         use-xmlto = xmlto
121         prefer-xmlto = xmlto
122 else
123         use-xmlto = notfound
124         prefer-xmlto = $(use-db2x)
125 endif
126
127 # the commands, generated from the chosen template
128 quiet_cmd_db2ps = PS      $@
129       cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
130 %.ps : %.xml
131         $(call cmd,db2ps)
132
133 quiet_cmd_db2pdf = PDF     $@
134       cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
135 %.pdf : %.xml
136         $(call cmd,db2pdf)
137
138
139 index = index.html
140 main_idx = Documentation/DocBook/$(index)
141 build_main_index = rm -rf $(main_idx); \
142                    echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
143                    echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
144                    cat $(HTML) >> $(main_idx)
145
146 quiet_cmd_db2html = HTML    $@
147       cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
148                 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
149         $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
150
151 %.html: %.xml
152         @(which xmlto > /dev/null 2>&1) || \
153          (echo "*** You need to install xmlto ***"; \
154           exit 1)
155         @rm -rf $@ $(patsubst %.html,%,$@)
156         $(call cmd,db2html)
157         @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
158             cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
159
160 quiet_cmd_db2man = MAN     $@
161       cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
162 %.9 : %.xml
163         @(which xmlto > /dev/null 2>&1) || \
164          (echo "*** You need to install xmlto ***"; \
165           exit 1)
166         $(Q)mkdir -p $(obj)/man
167         $(call cmd,db2man)
168         @touch $@
169
170 ###
171 # Rules to generate postscripts and PNG images from .fig format files
172 quiet_cmd_fig2eps = FIG2EPS $@
173       cmd_fig2eps = fig2dev -Leps $< $@
174
175 %.eps: %.fig
176         @(which fig2dev > /dev/null 2>&1) || \
177          (echo "*** You need to install transfig ***"; \
178           exit 1)
179         $(call cmd,fig2eps)
180
181 quiet_cmd_fig2png = FIG2PNG $@
182       cmd_fig2png = fig2dev -Lpng $< $@
183
184 %.png: %.fig
185         @(which fig2dev > /dev/null 2>&1) || \
186          (echo "*** You need to install transfig ***"; \
187           exit 1)
188         $(call cmd,fig2png)
189
190 ###
191 # Rule to convert a .c file to inline XML documentation
192        gen_xml = :
193  quiet_gen_xml = echo '  GEN     $@'
194 silent_gen_xml = :
195 %.xml: %.c
196         @$($(quiet)gen_xml)
197         @(                            \
198            echo "<programlisting>";   \
199            expand --tabs=8 < $< |     \
200            sed -e "s/&/\\&amp;/g"     \
201                -e "s/</\\&lt;/g"      \
202                -e "s/>/\\&gt;/g";     \
203            echo "</programlisting>")  > $@
204
205 ###
206 # Help targets as used by the top-level makefile
207 dochelp:
208         @echo  ' Linux kernel internal documentation in different formats:'
209         @echo  '  htmldocs        - HTML'
210         @echo  '  pdfdocs         - PDF'
211         @echo  '  psdocs          - Postscript'
212         @echo  '  xmldocs         - XML DocBook'
213         @echo  '  mandocs         - man pages'
214         @echo  '  installmandocs  - install man pages generated by mandocs'
215         @echo  '  cleandocs       - clean all generated DocBook files'
216
217 ###
218 # Temporary files left by various tools
219 clean-files := $(DOCBOOKS) \
220         $(patsubst %.xml, %.dvi,  $(DOCBOOKS)) \
221         $(patsubst %.xml, %.aux,  $(DOCBOOKS)) \
222         $(patsubst %.xml, %.tex,  $(DOCBOOKS)) \
223         $(patsubst %.xml, %.log,  $(DOCBOOKS)) \
224         $(patsubst %.xml, %.out,  $(DOCBOOKS)) \
225         $(patsubst %.xml, %.ps,   $(DOCBOOKS)) \
226         $(patsubst %.xml, %.pdf,  $(DOCBOOKS)) \
227         $(patsubst %.xml, %.html, $(DOCBOOKS)) \
228         $(patsubst %.xml, %.9,    $(DOCBOOKS)) \
229         $(index)
230
231 clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
232
233 cleandocs: cleanmediadocs
234         $(Q)rm -f $(call objectify, $(clean-files))
235         $(Q)rm -rf $(call objectify, $(clean-dirs))
236
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)