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