[mirror_ubuntu-artful-kernel.git] / Documentation / DocBook / Makefile

###
# This makefile is used to generate the kernel documentation,
# primarily based on in-line comments in various source files.
# See Documentation/kernel-doc-nano-HOWTO.txt for instruction in how
# to document the SRC - and how to read it.
# To add a new book the only step required is to add the book to the
# list of DOCBOOKS.

TMPMEDIA=.tmpmedia

DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
	    writing_usb_driver.xml networking.xml \
	    kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
	    gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
	    genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
	    80211.xml debugobjects.xml sh.xml regulator.xml \
	    alsa-driver-api.xml writing-an-alsa-driver.xml \
	    tracepoint.xml $(TMPMEDIA)/media.xml drm.xml

###
# The build process is as follows (targets):
#              (xmldocs) [by docproc]
# file.tmpl --> file.xml +--> file.ps   (psdocs)   [by db2ps or xmlto]
#                        +--> file.pdf  (pdfdocs)  [by db2pdf or xmlto]
#                        +--> DIR=file  (htmldocs) [by xmlto]
#                        +--> man/      (mandocs)  [by xmlto]


# for PDF and PS output you can choose between xmlto and docbook-utils tools
PDF_METHOD	= $(prefer-db2x)
PS_METHOD	= $(prefer-db2x)


###
# The targets that may be used.
PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs mediaprep

BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
xmldocs: $(BOOKS)
sgmldocs: xmldocs

PS := $(patsubst %.xml, %.ps, $(BOOKS))
psdocs: $(PS)

PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
pdfdocs: $(PDF)

HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
htmldocs: $(HTML)
	$(call build_main_index)
	$(call build_images)

MAN := $(patsubst %.xml, %.9, $(BOOKS))
mandocs: $(MAN)

installmandocs: mandocs
	mkdir -p /usr/local/man/man9/
	install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/

###
#External programs used
KERNELDOC = $(srctree)/scripts/kernel-doc
DOCPROC   = $(objtree)/scripts/docproc

XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
XMLTOFLAGS += --skip-validation

###
# DOCPROC is used for two purposes:
# 1) To generate a dependency list for a .tmpl file
# 2) To preprocess a .tmpl file and call kernel-doc with
#     appropriate parameters.
# The following rules are used to generate the .xml documentation
# required to generate the final targets. (ps, pdf, html).
quiet_cmd_docproc = DOCPROC $@
      cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
define rule_docproc
	set -e;								\
        $(if $($(quiet)cmd_$(1)),echo '  $($(quiet)cmd_$(1))';) 	\
        $(cmd_$(1)); 							\
        ( 								\
          echo 'cmd_$@ := $(cmd_$(1))'; 				\
          echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; 		\
        ) > $(dir $@).$(notdir $@).cmd
endef

%.xml: %.tmpl FORCE
	$(call if_changed_rule,docproc)

###
#Read in all saved dependency files
cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))

ifneq ($(cmd_files),)
  include $(cmd_files)
endif

###
# Changes in kernel-doc force a rebuild of all documentation
$(BOOKS): $(KERNELDOC)

# Tell kbuild to always build the programs
always := $(hostprogs-y)

notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
		   exit 1
db2xtemplate = db2TYPE -o $(dir $@) $<
xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<

# determine which methods are available
ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
	use-db2x = db2x
	prefer-db2x = db2x
else
	use-db2x = notfound
	prefer-db2x = $(use-xmlto)
endif
ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
	use-xmlto = xmlto
	prefer-xmlto = xmlto
else
	use-xmlto = notfound
	prefer-xmlto = $(use-db2x)
endif

# the commands, generated from the chosen template
quiet_cmd_db2ps = PS      $@
      cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
%.ps : %.xml
	$(call cmd,db2ps)

quiet_cmd_db2pdf = PDF     $@
      cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
%.pdf : %.xml
	$(call cmd,db2pdf)


index = index.html
main_idx = Documentation/DocBook/$(index)
build_main_index = rm -rf $(main_idx); \
		   echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
		   echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
		   cat $(HTML) >> $(main_idx)

quiet_cmd_db2html = HTML    $@
      cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
		echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
        $(patsubst %.html,%,$(notdir $@))</a><p>' > $@

%.html:	%.xml
	@(which xmlto > /dev/null 2>&1) || \
	 (echo "*** You need to install xmlto ***"; \
	  exit 1)
	@rm -rf $@ $(patsubst %.html,%,$@)
	$(call cmd,db2html)
	@if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
            cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi

quiet_cmd_db2man = MAN     $@
      cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
%.9 : %.xml
	@(which xmlto > /dev/null 2>&1) || \
	 (echo "*** You need to install xmlto ***"; \
	  exit 1)
	$(Q)mkdir -p $(obj)/man
	$(call cmd,db2man)
	@touch $@

###
# Rules to generate postscripts and PNG images from .fig format files
quiet_cmd_fig2eps = FIG2EPS $@
      cmd_fig2eps = fig2dev -Leps $< $@

%.eps: %.fig
	@(which fig2dev > /dev/null 2>&1) || \
	 (echo "*** You need to install transfig ***"; \
	  exit 1)
	$(call cmd,fig2eps)

quiet_cmd_fig2png = FIG2PNG $@
      cmd_fig2png = fig2dev -Lpng $< $@

%.png: %.fig
	@(which fig2dev > /dev/null 2>&1) || \
	 (echo "*** You need to install transfig ***"; \
	  exit 1)
	$(call cmd,fig2png)

###
# Rule to convert a .c file to inline XML documentation
       gen_xml = :
 quiet_gen_xml = echo '  GEN     $@'
silent_gen_xml = :
%.xml: %.c
	@$($(quiet)gen_xml)
	@(                            \
	   echo "<programlisting>";   \
	   expand --tabs=8 < $< |     \
	   sed -e "s/&/\\&amp;/g"     \
	       -e "s/</\\&lt;/g"      \
	       -e "s/>/\\&gt;/g";     \
	   echo "</programlisting>")  > $@

###
# Help targets as used by the top-level makefile
dochelp:
	@echo  ' Linux kernel internal documentation in different formats:'
	@echo  '  htmldocs        - HTML'
	@echo  '  pdfdocs         - PDF'
	@echo  '  psdocs          - Postscript'
	@echo  '  xmldocs         - XML DocBook'
	@echo  '  mandocs         - man pages'
	@echo  '  installmandocs  - install man pages generated by mandocs'
	@echo  '  cleandocs       - clean all generated DocBook files'

###
# Temporary files left by various tools
clean-files := $(DOCBOOKS) \
	$(patsubst %.xml, %.dvi,  $(DOCBOOKS)) \
	$(patsubst %.xml, %.aux,  $(DOCBOOKS)) \
	$(patsubst %.xml, %.tex,  $(DOCBOOKS)) \
	$(patsubst %.xml, %.log,  $(DOCBOOKS)) \
	$(patsubst %.xml, %.out,  $(DOCBOOKS)) \
	$(patsubst %.xml, %.ps,   $(DOCBOOKS)) \
	$(patsubst %.xml, %.pdf,  $(DOCBOOKS)) \
	$(patsubst %.xml, %.html, $(DOCBOOKS)) \
	$(patsubst %.xml, %.9,    $(DOCBOOKS)) \
	$(index)

clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man $(MEDIA_DIR)

cleandocs:
	$(Q)rm -f $(call objectify, $(clean-files))
	$(Q)rm -rf $(call objectify, $(clean-dirs))

# Declare the contents of the .PHONY variable as phony.  We keep that
# information in a variable se we can use it in if_changed and friends.

.PHONY: $(PHONY)


#
# Media build rules - Auto-generates media contents/indexes and *.h xml's
#

SHELL=/bin/bash

MEDIA_DIR=$(objtree)/Documentation/DocBook/$(TMPMEDIA)

V4L_SGMLS = \
	$(shell ls $(srctree)/Documentation/DocBook/v4l/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)') \
	capture.c.xml \
	keytable.c.xml \
	v4l2grab.c.xml

DVB_SGMLS = \
	$(shell ls $(srctree)/Documentation/DocBook/dvb/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)')

MEDIA_TEMP =  media-entities.tmpl \
	      media-indices.tmpl \
	      videodev2.h.xml \
	      frontend.h.xml

MEDIA_SGMLS =  $(addprefix ./,$(V4L_SGMLS)) $(addprefix ./,$(DVB_SGMLS)) $(addprefix ./,$(MEDIA_TEMP))

MEDIA_TEMP_OBJ := $(addprefix $(MEDIA_DIR)/,$(MEDIA_TEMP))

FUNCS = \
	close \
	ioctl \
	mmap \
	munmap \
	open \
	poll \
	read \
	select \
	write \

IOCTLS = \
	$(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/videodev2.h) \
	$(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/media.h) \
	$(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/v4l2-subdev.h) \
	VIDIOC_SUBDEV_G_FRAME_INTERVAL \
	VIDIOC_SUBDEV_S_FRAME_INTERVAL \
	VIDIOC_SUBDEV_ENUM_MBUS_CODE \
	VIDIOC_SUBDEV_ENUM_FRAME_SIZE \
	VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL \

TYPES = \
	$(shell perl -ne 'print "$$1 " if /^typedef\s+[^\s]+\s+([^\s]+)\;/' $(srctree)/include/linux/videodev2.h)

ENUMS = \
	$(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
	$(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
	$(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h) \
	$(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h)

STRUCTS = \
	$(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
	$(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
	$(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h) \
	$(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h)

ERRORS = \
	EACCES \
	EAGAIN \
	EBADF \
	EBUSY \
	EFAULT \
	EIO \
	EINTR \
	EINVAL \
	ENFILE \
	ENOMEM \
	ENOSPC \
	ENOTTY \
	ENXIO \
	EMFILE \
	EPERM \
	ERANGE \
	EPIPE \

ESCAPE = \
	-e "s/&/\\&amp;/g" \
	-e "s/</\\&lt;/g" \
	-e "s/>/\\&gt;/g"

FILENAME = \
	-e s,"^[^\/]*/",, \
	-e s/"\\.xml"// \
	-e s/"\\.tmpl"// \
	-e s/\\\./-/g \
	-e s/"^func-"// \
	-e s/"^pixfmt-"// \
	-e s/"^vidioc-"//

# Generate references to these structs in videodev2.h.xml.
DOCUMENTED = \
	-e "s/\(enum *\)v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1<link linkend=\"\2\">v4l2_mpeg_cx2341x_video_\2<\/link>/g" \
	-e "s/\(\(enum\|struct\) *\)\(v4l2_[a-zA-Z0-9_]*\)/\1<link linkend=\"\3\">\3<\/link>/g" \
	-e "s/\(V4L2_PIX_FMT_[A-Z0-9_]\+\) /<link linkend=\"\1\">\1<\/link> /g" \
	-e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
	-e "s/v4l2\-mpeg\-vbi\-ITV0/v4l2-mpeg-vbi-itv0-1/g"

DVB_DOCUMENTED = \
	-e "s,\(define \)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
	-e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g"


#
# Media targets and dependencies
#

$(obj)/$(TMPMEDIA)/media.xml: $(obj)/media.tmpl $(MEDIA_TEMP_OBJ) FORCE
	$(call if_changed_rule,docproc)

$(MEDIA_DIR)/v4l2.xml:
	@$($(quiet)gen_xml)
	@(mkdir -p $(MEDIA_DIR))
	@(cp $(srctree)/Documentation/DocBook/dvb/*.png $(srctree)/Documentation/DocBook/v4l/*.gif $(MEDIA_DIR)/)
	@(ln -sf $(srctree)/Documentation/DocBook/v4l/*xml $(MEDIA_DIR)/)
	@(ln -sf $(srctree)/Documentation/DocBook/dvb/*xml $(MEDIA_DIR)/)

$(MEDIA_DIR)/videodev2.h.xml: $(srctree)/include/linux/videodev2.h $(MEDIA_DIR)/v4l2.xml
	@$($(quiet)gen_xml)
	@(					\
	echo "<programlisting>") > $@
	@(					\
	expand --tabs=8 < $< |			\
	  sed $(ESCAPE) $(DOCUMENTED) |		\
	  sed 's/i\.e\./&ie;/') >> $@
	@(					\
	echo "</programlisting>") >> $@

$(MEDIA_DIR)/frontend.h.xml: $(srctree)/include/linux/dvb/frontend.h $(MEDIA_DIR)/v4l2.xml
	@$($(quiet)gen_xml)
	@(					\
	echo "<programlisting>") > $@
	@(					\
	expand --tabs=8 < $< |			\
	  sed $(ESCAPE) $(DVB_DOCUMENTED) |	\
	  sed 's/i\.e\./&ie;/') >> $@
	@(					\
	echo "</programlisting>") >> $@

$(MEDIA_DIR)/media-entities.tmpl: $(MEDIA_DIR)/v4l2.xml
	@$($(quiet)gen_xml)
	@(								\
	echo "<!-- Generated file! Do not edit. -->") >$@
	@(								\
	echo -e "\n<!-- Functions -->") >>$@
	@(								\
	for ident in $(FUNCS) ; do					\
	  entity=`echo $$ident | tr _ -` ;				\
	  echo "<!ENTITY func-$$entity \"<link"				\
	    "linkend='func-$$entity'><function>$$ident()</function></link>\">" \
	  >>$@ ;							\
	done)
	@(								\
	echo -e "\n<!-- Ioctls -->") >>$@
	@(								\
	for ident in $(IOCTLS) ; do					\
	  entity=`echo $$ident | tr _ -` ;				\
	  id=`grep "<refname>$$ident" $(MEDIA_DIR)/vidioc-*.xml | sed -r s,"^.*/(.*).xml.*","\1",` ; \
	  echo "<!ENTITY $$entity \"<link"				\
	    "linkend='$$id'><constant>$$ident</constant></link>\">"	\
	  >>$@ ;							\
	done)
	@(								\
	echo -e "\n<!-- Types -->") >>$@
	@(								\
	for ident in $(TYPES) ; do					\
	  entity=`echo $$ident | tr _ -` ;				\
	  echo "<!ENTITY $$entity \"<link"				\
	    "linkend='$$entity'>$$ident</link>\">" >>$@ ;		\
	done)
	@(								\
	echo -e "\n<!-- Enums -->") >>$@
	@(								\
	for ident in $(ENUMS) ; do					\
	  entity=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -` ; \
	  echo "<!ENTITY $$entity \"enum&nbsp;<link"			\
	    "linkend='$$entity'>$$ident</link>\">" >>$@ ;		\
	done)
	@(								\
	echo -e "\n<!-- Structures -->") >>$@
	@(								\
	for ident in $(STRUCTS) ; do					\
	  entity=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
	  echo "<!ENTITY $$entity \"struct&nbsp;<link"			\
	    "linkend='$$entity'>$$ident</link>\">" >>$@ ;		\
	done)
	@(								\
	echo -e "\n<!-- Error Codes -->") >>$@
	@(								\
	for ident in $(ERRORS) ; do					\
	  echo "<!ENTITY $$ident \"<errorcode>$$ident</errorcode>"	\
	    "error code\">" >>$@ ;					\
	done)
	@(								\
	echo -e "\n<!-- Subsections -->") >>$@
	@(								\
	for file in $(MEDIA_SGMLS) ; do					\
	  entity=`echo "$$file" | sed $(FILENAME) -e s/"^([^-]*)"/sub\1/` ; \
	  if ! echo "$$file" |						\
	    grep -q -E -e '^(func|vidioc|pixfmt)-' ; then		\
	    echo "<!ENTITY sub-$$entity SYSTEM \"$$file\">" >>$@ ;	\
	  fi ;								\
	done)
	@(								\
	echo -e "\n<!-- Function Reference -->") >>$@
	@(								\
	for file in $(MEDIA_SGMLS) ; do					\
	  if echo "$$file" |						\
	    grep -q -E -e '(func|vidioc|pixfmt)-' ; then		\
	    entity=`echo "$$file" |sed $(FILENAME)` ;			\
	    echo "<!ENTITY $$entity SYSTEM \"$$file\">" >>$@ ;	\
	  fi ;								\
	done)

# Jade can auto-generate a list-of-tables, which includes all structs,
# but we only want data types, all types, and sorted please.
$(MEDIA_DIR)/media-indices.tmpl: $(MEDIA_DIR)/v4l2.xml
	@$($(quiet)gen_xml)
	@(								\
	echo "<!-- Generated file! Do not edit. -->") >$@
	@(								\
	echo -e "\n<index><title>List of Types</title>") >>$@
	@(								\
	for ident in $(TYPES) ; do					\
	  id=`echo $$ident | tr _ -` ;					\
	  echo "<indexentry><primaryie><link"				\
	    "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
	done)
	@(								\
	for ident in $(ENUMS) ; do					\
	  id=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -`; \
	  echo "<indexentry><primaryie>enum&nbsp;<link"			\
	    "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
	done)
	@(								\
	for ident in $(STRUCTS) ; do					\
	  id=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
	  echo "<indexentry><primaryie>struct&nbsp;<link"		\
	    "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
	done)
	@(								\
	echo "</index>") >>$@
Commit	Line	Data
1da177e4 LT	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
58ef2c4c	5	# to document the SRC - and how to read it.
1da177e4 LT	6	# To add a new book the only step required is to add the book to the
	7	# list of DOCBOOKS.
	8
04893043 MCC	9	TMPMEDIA=.tmpmedia
04893043 MCC	10
f7f84f38	11	DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
ac9296f9	12	kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
82c1e49c	13	writing_usb_driver.xml networking.xml \
e3e2aaf7	14	kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
11c869ea	15	gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
dbbea671	16	genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
352de557	17	80211.xml debugobjects.xml sh.xml regulator.xml \
a76f8c6d	18	alsa-driver-api.xml writing-an-alsa-driver.xml \
04893043	19	tracepoint.xml $(TMPMEDIA)/media.xml drm.xml
1da177e4 LT	20
	21	###
	22	# The build process is as follows (targets):
2ac534bc RD	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]
1da177e4	28
71f95cfb MW	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
1da177e4 LT	35	###
1da177e4 LT	36	# The targets that may be used.
04893043	37	PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs mediaprep
1da177e4 LT	38
1da177e4 LT	39	BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
a435600e	40	xmldocs: $(BOOKS)
1da177e4 LT	41	sgmldocs: xmldocs
	42
	43	PS := $(patsubst %.xml, %.ps, $(BOOKS))
	44	psdocs: $(PS)
	45
	46	PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
	47	pdfdocs: $(PDF)
	48
f15a3ccd	49	HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
04893043	50	htmldocs: $(HTML)
eb81d930	51	$(call build_main_index)
49b14650	52	$(call build_images)
1da177e4 LT	53
	54	MAN := $(patsubst %.xml, %.9, $(BOOKS))
	55	mandocs: $(MAN)
	56
	57	installmandocs: mandocs
8b0c2d98 MW	58	mkdir -p /usr/local/man/man9/
8b0c2d98 MW	59	install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
1da177e4 LT	60
	61	###
	62	#External programs used
829ad751	63	KERNELDOC = $(srctree)/scripts/kernel-doc
bffd2020	64	DOCPROC = $(objtree)/scripts/docproc
8b0c2d98	65
597f6eea	66	XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
82c1e49c	67	XMLTOFLAGS += --skip-validation
1da177e4 LT	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
04893043	88	%.xml: %.tmpl FORCE
1da177e4 LT	89	$(call if_changed_rule,docproc)
	90
	91	###
04893043	92	#Read in all saved dependency files
1da177e4 LT	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
3794f3e8 RD	103	# Tell kbuild to always build the programs
	104	always := $(hostprogs-y)
	105
71f95cfb MW	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
1da177e4	126
71f95cfb MW	127	# the commands, generated from the chosen template
	128	quiet_cmd_db2ps = PS $@
	129	cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
1da177e4	130	%.ps : %.xml
1da177e4 LT	131	$(call cmd,db2ps)
1da177e4 LT	132
a34645f5	133	quiet_cmd_db2pdf = PDF $@
71f95cfb	134	cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
1da177e4	135	%.pdf : %.xml
1da177e4 LT	136	$(call cmd,db2pdf)
1da177e4 LT	137
eb81d930	138
64e3da10 RD	139	index = index.html
64e3da10 RD	140	main_idx = Documentation/DocBook/$(index)
04893043	141	build_main_index = rm -rf $(main_idx); \
eb81d930 BP	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
a34645f5	146	quiet_cmd_db2html = HTML $@
8b0c2d98	147	cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
4fa35166	148	echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
eb81d930	149	$(patsubst %.html,%,$(notdir $@))</a><p>' > $@
1da177e4 LT	150
1da177e4 LT	151	%.html: %.xml
8b0c2d98	152	@(which xmlto > /dev/null 2>&1) \|\| \
fd4a3244	153	(echo "* You need to install xmlto *"; \
1da177e4 LT	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
71f95cfb	160	quiet_cmd_db2man = MAN $@
8b0c2d98 MW	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) \|\| \
fd4a3244	164	(echo "* You need to install xmlto *"; \
8b0c2d98	165	exit 1)
e711db3e	166	$(Q)mkdir -p $(obj)/man
8b0c2d98 MW	167	$(call cmd,db2man)
8b0c2d98 MW	168	@touch $@
1da177e4 LT	169
1da177e4 LT	170	###
0f035b8e	171	# Rules to generate postscripts and PNG images from .fig format files
1da177e4 LT	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
759cd603 MF	192	gen_xml = :
	193	quiet_gen_xml = echo ' GEN $@'
	194	silent_gen_xml = :
1da177e4	195	%.xml: %.c
759cd603	196	@$($(quiet)gen_xml)
1da177e4 LT	197	@( \
	198	echo "<programlisting>"; \
	199	expand --tabs=8 < $< \| \
	200	sed -e "s/&/\\&/g" \
	201	-e "s/</\\</g" \
	202	-e "s/>/\\>/g"; \
	203	echo "</programlisting>") > $@
	204
	205	###
	206	# Help targets as used by the top-level makefile
	207	dochelp:
6fc52f81 JJ	208	@echo ' Linux kernel internal documentation in different formats:'
6fc52f81 JJ	209	@echo ' htmldocs - HTML'
6fc52f81 JJ	210	@echo ' pdfdocs - PDF'
	211	@echo ' psdocs - Postscript'
	212	@echo ' xmldocs - XML DocBook'
2810ae8c RD	213	@echo ' mandocs - man pages'
	214	@echo ' installmandocs - install man pages generated by mandocs'
	215	@echo ' cleandocs - clean all generated DocBook files'
1da177e4 LT	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)) \
82c1e49c	229	$(index)
1da177e4	230
04893043	231	clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man $(MEDIA_DIR)
4f193362	232
2810ae8c RD	233	cleandocs:
	234	$(Q)rm -f $(call objectify, $(clean-files))
	235	$(Q)rm -rf $(call objectify, $(clean-dirs))
	236
4f193362 PS	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)
04893043 MCC	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/&/\\&/g" \
326	-e "s/</\\</g" \
327	-e "s/>/\\>/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 <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 <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 <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 <link" \
486	"linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
487	done)
488	@( \
489	echo "</index>") >>$@