[media] DocBook: Add rules to auto-generate some media docbook
[pandora-kernel.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 TMPMEDIA=.tmpmedia
10
11 DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
12             kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
13             writing_usb_driver.xml networking.xml \
14             kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
15             gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
16             genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
17             80211.xml debugobjects.xml sh.xml regulator.xml \
18             alsa-driver-api.xml writing-an-alsa-driver.xml \
19             tracepoint.xml $(TMPMEDIA)/media.xml drm.xml
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 mediaprep
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 $(MEDIA_DIR)
232
233 cleandocs:
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)
241
242
243 #
244 # Media build rules - Auto-generates media contents/indexes and *.h xml's
245 #
246
247 SHELL=/bin/bash
248
249 MEDIA_DIR=$(objtree)/Documentation/DocBook/$(TMPMEDIA)
250
251 V4L_SGMLS = \
252         $(shell ls $(srctree)/Documentation/DocBook/v4l/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)') \
253         capture.c.xml \
254         keytable.c.xml \
255         v4l2grab.c.xml
256
257 DVB_SGMLS = \
258         $(shell ls $(srctree)/Documentation/DocBook/dvb/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)')
259
260 MEDIA_TEMP =  media-entities.tmpl \
261               media-indices.tmpl \
262               videodev2.h.xml \
263               frontend.h.xml
264
265 MEDIA_SGMLS =  $(addprefix ./,$(V4L_SGMLS)) $(addprefix ./,$(DVB_SGMLS)) $(addprefix ./,$(MEDIA_TEMP))
266
267 MEDIA_TEMP_OBJ := $(addprefix $(MEDIA_DIR)/,$(MEDIA_TEMP))
268
269 FUNCS = \
270         close \
271         ioctl \
272         mmap \
273         munmap \
274         open \
275         poll \
276         read \
277         select \
278         write \
279
280 IOCTLS = \
281         $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/videodev2.h) \
282         $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/media.h) \
283         $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/v4l2-subdev.h) \
284         VIDIOC_SUBDEV_G_FRAME_INTERVAL \
285         VIDIOC_SUBDEV_S_FRAME_INTERVAL \
286         VIDIOC_SUBDEV_ENUM_MBUS_CODE \
287         VIDIOC_SUBDEV_ENUM_FRAME_SIZE \
288         VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL \
289
290 TYPES = \
291         $(shell perl -ne 'print "$$1 " if /^typedef\s+[^\s]+\s+([^\s]+)\;/' $(srctree)/include/linux/videodev2.h)
292
293 ENUMS = \
294         $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
295         $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
296         $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h) \
297         $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h)
298
299 STRUCTS = \
300         $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
301         $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
302         $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h) \
303         $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h)
304
305 ERRORS = \
306         EACCES \
307         EAGAIN \
308         EBADF \
309         EBUSY \
310         EFAULT \
311         EIO \
312         EINTR \
313         EINVAL \
314         ENFILE \
315         ENOMEM \
316         ENOSPC \
317         ENOTTY \
318         ENXIO \
319         EMFILE \
320         EPERM \
321         ERANGE \
322         EPIPE \
323
324 ESCAPE = \
325         -e "s/&/\\&amp;/g" \
326         -e "s/</\\&lt;/g" \
327         -e "s/>/\\&gt;/g"
328
329 FILENAME = \
330         -e s,"^[^\/]*/",, \
331         -e s/"\\.xml"// \
332         -e s/"\\.tmpl"// \
333         -e s/\\\./-/g \
334         -e s/"^func-"// \
335         -e s/"^pixfmt-"// \
336         -e s/"^vidioc-"//
337
338 # Generate references to these structs in videodev2.h.xml.
339 DOCUMENTED = \
340         -e "s/\(enum *\)v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1<link linkend=\"\2\">v4l2_mpeg_cx2341x_video_\2<\/link>/g" \
341         -e "s/\(\(enum\|struct\) *\)\(v4l2_[a-zA-Z0-9_]*\)/\1<link linkend=\"\3\">\3<\/link>/g" \
342         -e "s/\(V4L2_PIX_FMT_[A-Z0-9_]\+\) /<link linkend=\"\1\">\1<\/link> /g" \
343         -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
344         -e "s/v4l2\-mpeg\-vbi\-ITV0/v4l2-mpeg-vbi-itv0-1/g"
345
346 DVB_DOCUMENTED = \
347         -e "s,\(define \)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
348         -e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g"
349
350
351 #
352 # Media targets and dependencies
353 #
354
355 $(obj)/$(TMPMEDIA)/media.xml: $(obj)/media.tmpl $(MEDIA_TEMP_OBJ) FORCE
356         $(call if_changed_rule,docproc)
357
358 $(MEDIA_DIR)/v4l2.xml:
359         @$($(quiet)gen_xml)
360         @(mkdir -p $(MEDIA_DIR))
361         @(cp $(srctree)/Documentation/DocBook/dvb/*.png $(srctree)/Documentation/DocBook/v4l/*.gif $(MEDIA_DIR)/)
362         @(ln -sf $(srctree)/Documentation/DocBook/v4l/*xml $(MEDIA_DIR)/)
363         @(ln -sf $(srctree)/Documentation/DocBook/dvb/*xml $(MEDIA_DIR)/)
364
365 $(MEDIA_DIR)/videodev2.h.xml: $(srctree)/include/linux/videodev2.h $(MEDIA_DIR)/v4l2.xml
366         @$($(quiet)gen_xml)
367         @(                                      \
368         echo "<programlisting>") > $@
369         @(                                      \
370         expand --tabs=8 < $< |                  \
371           sed $(ESCAPE) $(DOCUMENTED) |         \
372           sed 's/i\.e\./&ie;/') >> $@
373         @(                                      \
374         echo "</programlisting>") >> $@
375
376 $(MEDIA_DIR)/frontend.h.xml: $(srctree)/include/linux/dvb/frontend.h $(MEDIA_DIR)/v4l2.xml
377         @$($(quiet)gen_xml)
378         @(                                      \
379         echo "<programlisting>") > $@
380         @(                                      \
381         expand --tabs=8 < $< |                  \
382           sed $(ESCAPE) $(DVB_DOCUMENTED) |     \
383           sed 's/i\.e\./&ie;/') >> $@
384         @(                                      \
385         echo "</programlisting>") >> $@
386
387 $(MEDIA_DIR)/media-entities.tmpl: $(MEDIA_DIR)/v4l2.xml
388         @$($(quiet)gen_xml)
389         @(                                                              \
390         echo "<!-- Generated file! Do not edit. -->") >$@
391         @(                                                              \
392         echo -e "\n<!-- Functions -->") >>$@
393         @(                                                              \
394         for ident in $(FUNCS) ; do                                      \
395           entity=`echo $$ident | tr _ -` ;                              \
396           echo "<!ENTITY func-$$entity \"<link"                         \
397             "linkend='func-$$entity'><function>$$ident()</function></link>\">" \
398           >>$@ ;                                                        \
399         done)
400         @(                                                              \
401         echo -e "\n<!-- Ioctls -->") >>$@
402         @(                                                              \
403         for ident in $(IOCTLS) ; do                                     \
404           entity=`echo $$ident | tr _ -` ;                              \
405           id=`grep "<refname>$$ident" $(MEDIA_DIR)/vidioc-*.xml | sed -r s,"^.*/(.*).xml.*","\1",` ; \
406           echo "<!ENTITY $$entity \"<link"                              \
407             "linkend='$$id'><constant>$$ident</constant></link>\">"     \
408           >>$@ ;                                                        \
409         done)
410         @(                                                              \
411         echo -e "\n<!-- Types -->") >>$@
412         @(                                                              \
413         for ident in $(TYPES) ; do                                      \
414           entity=`echo $$ident | tr _ -` ;                              \
415           echo "<!ENTITY $$entity \"<link"                              \
416             "linkend='$$entity'>$$ident</link>\">" >>$@ ;               \
417         done)
418         @(                                                              \
419         echo -e "\n<!-- Enums -->") >>$@
420         @(                                                              \
421         for ident in $(ENUMS) ; do                                      \
422           entity=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -` ; \
423           echo "<!ENTITY $$entity \"enum&nbsp;<link"                    \
424             "linkend='$$entity'>$$ident</link>\">" >>$@ ;               \
425         done)
426         @(                                                              \
427         echo -e "\n<!-- Structures -->") >>$@
428         @(                                                              \
429         for ident in $(STRUCTS) ; do                                    \
430           entity=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
431           echo "<!ENTITY $$entity \"struct&nbsp;<link"                  \
432             "linkend='$$entity'>$$ident</link>\">" >>$@ ;               \
433         done)
434         @(                                                              \
435         echo -e "\n<!-- Error Codes -->") >>$@
436         @(                                                              \
437         for ident in $(ERRORS) ; do                                     \
438           echo "<!ENTITY $$ident \"<errorcode>$$ident</errorcode>"      \
439             "error code\">" >>$@ ;                                      \
440         done)
441         @(                                                              \
442         echo -e "\n<!-- Subsections -->") >>$@
443         @(                                                              \
444         for file in $(MEDIA_SGMLS) ; do                                 \
445           entity=`echo "$$file" | sed $(FILENAME) -e s/"^([^-]*)"/sub\1/` ; \
446           if ! echo "$$file" |                                          \
447             grep -q -E -e '^(func|vidioc|pixfmt)-' ; then               \
448             echo "<!ENTITY sub-$$entity SYSTEM \"$$file\">" >>$@ ;      \
449           fi ;                                                          \
450         done)
451         @(                                                              \
452         echo -e "\n<!-- Function Reference -->") >>$@
453         @(                                                              \
454         for file in $(MEDIA_SGMLS) ; do                                 \
455           if echo "$$file" |                                            \
456             grep -q -E -e '(func|vidioc|pixfmt)-' ; then                \
457             entity=`echo "$$file" |sed $(FILENAME)` ;                   \
458             echo "<!ENTITY $$entity SYSTEM \"$$file\">" >>$@ ;  \
459           fi ;                                                          \
460         done)
461
462 # Jade can auto-generate a list-of-tables, which includes all structs,
463 # but we only want data types, all types, and sorted please.
464 $(MEDIA_DIR)/media-indices.tmpl: $(MEDIA_DIR)/v4l2.xml
465         @$($(quiet)gen_xml)
466         @(                                                              \
467         echo "<!-- Generated file! Do not edit. -->") >$@
468         @(                                                              \
469         echo -e "\n<index><title>List of Types</title>") >>$@
470         @(                                                              \
471         for ident in $(TYPES) ; do                                      \
472           id=`echo $$ident | tr _ -` ;                                  \
473           echo "<indexentry><primaryie><link"                           \
474             "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
475         done)
476         @(                                                              \
477         for ident in $(ENUMS) ; do                                      \
478           id=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -`; \
479           echo "<indexentry><primaryie>enum&nbsp;<link"                 \
480             "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
481         done)
482         @(                                                              \
483         for ident in $(STRUCTS) ; do                                    \
484           id=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
485           echo "<indexentry><primaryie>struct&nbsp;<link"               \
486             "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
487         done)
488         @(                                                              \
489         echo "</index>") >>$@