[net-next-2.6.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.

DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
	    procfs-guide.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 \
	    mac80211.xml debugobjects.xml sh.xml regulator.xml \
	    alsa-driver-api.xml writing-an-alsa-driver.xml \
	    tracepoint.xml media.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 xmldoclinks

BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
xmldocs: $(BOOKS) xmldoclinks
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)

build_images = mkdir -p $(objtree)/Documentation/DocBook/media/ && \
	       cp $(srctree)/Documentation/DocBook/dvb/*.png $(srctree)/Documentation/DocBook/v4l/*.gif $(objtree)/Documentation/DocBook/media/

xmldoclinks:
ifneq ($(objtree),$(srctree))
	for dep in dvb media-entities.tmpl media-indices.tmpl v4l; do \
		rm -f $(objtree)/Documentation/DocBook/$$dep \
		&& ln -s $(srctree)/Documentation/DocBook/$$dep $(objtree)/Documentation/DocBook/ \
		|| exit; \
	done
endif

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/basic/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)

###
# procfs guide uses a .c file as example code.
# This requires an explicit dependency
C-procfs-example = procfs_example.xml
C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
$(obj)/procfs-guide.xml: $(C-procfs-example2)

# List of programs to build
##oops, this is a kernel module::hostprogs-y := procfs_example
obj-m += procfs_example.o

# 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)) \
	$(C-procfs-example) $(index)

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

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)
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
f7f84f38	9	DOCBOOKS := z8530book.xml mcabook.xml device-drivers.xml \
ac9296f9	10	kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
bc2cda1e	11	procfs-guide.xml writing_usb_driver.xml networking.xml \
e3e2aaf7	12	kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
11c869ea	13	gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
dbbea671	14	genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
e776ec19	15	mac80211.xml debugobjects.xml sh.xml regulator.xml \
a76f8c6d	16	alsa-driver-api.xml writing-an-alsa-driver.xml \
8e080c2e	17	tracepoint.xml media.xml
1da177e4 LT	18
	19	###
	20	# The build process is as follows (targets):
2ac534bc RD	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]
1da177e4	26
71f95cfb MW	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
1da177e4 LT	33	###
1da177e4 LT	34	# The targets that may be used.
5bf58347	35	PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs xmldoclinks
1da177e4 LT	36
1da177e4 LT	37	BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
5bf58347	38	xmldocs: $(BOOKS) xmldoclinks
1da177e4 LT	39	sgmldocs: xmldocs
	40
	41	PS := $(patsubst %.xml, %.ps, $(BOOKS))
	42	psdocs: $(PS)
	43
	44	PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
	45	pdfdocs: $(PDF)
	46
f15a3ccd	47	HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
49b14650	48	htmldocs: $(HTML)
eb81d930	49	$(call build_main_index)
49b14650	50	$(call build_images)
1da177e4 LT	51
	52	MAN := $(patsubst %.xml, %.9, $(BOOKS))
	53	mandocs: $(MAN)
	54
49b14650 BH	55	build_images = mkdir -p $(objtree)/Documentation/DocBook/media/ && \
49b14650 BH	56	cp $(srctree)/Documentation/DocBook/dvb/.png $(srctree)/Documentation/DocBook/v4l/.gif $(objtree)/Documentation/DocBook/media/
7ac94055	57
5bf58347 BH	58	xmldoclinks:
	59	ifneq ($(objtree),$(srctree))
	60	for dep in dvb media-entities.tmpl media-indices.tmpl v4l; do \
	61	rm -f $(objtree)/Documentation/DocBook/$$dep \
	62	&& ln -s $(srctree)/Documentation/DocBook/$$dep $(objtree)/Documentation/DocBook/ \
	63	\|\| exit; \
	64	done
	65	endif
	66
1da177e4	67	installmandocs: mandocs
8b0c2d98 MW	68	mkdir -p /usr/local/man/man9/
8b0c2d98 MW	69	install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
1da177e4 LT	70
	71	###
	72	#External programs used
829ad751 MF	73	KERNELDOC = $(srctree)/scripts/kernel-doc
829ad751 MF	74	DOCPROC = $(objtree)/scripts/basic/docproc
8b0c2d98	75
597f6eea	76	XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl
2948e57d	77	#XMLTOFLAGS += --skip-validation
1da177e4 LT	78
	79	###
	80	# DOCPROC is used for two purposes:
	81	# 1) To generate a dependency list for a .tmpl file
	82	# 2) To preprocess a .tmpl file and call kernel-doc with
	83	# appropriate parameters.
	84	# The following rules are used to generate the .xml documentation
	85	# required to generate the final targets. (ps, pdf, html).
	86	quiet_cmd_docproc = DOCPROC $@
	87	cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
	88	define rule_docproc
	89	set -e; \
	90	$(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \
	91	$(cmd_$(1)); \
	92	( \
	93	echo 'cmd_$@ := $(cmd_$(1))'; \
	94	echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
	95	) > $(dir $@).$(notdir $@).cmd
	96	endef
	97
	98	%.xml: %.tmpl FORCE
	99	$(call if_changed_rule,docproc)
	100
	101	###
	102	#Read in all saved dependency files
	103	cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
	104
	105	ifneq ($(cmd_files),)
	106	include $(cmd_files)
	107	endif
	108
	109	###
	110	# Changes in kernel-doc force a rebuild of all documentation
	111	$(BOOKS): $(KERNELDOC)
	112
	113	###
	114	# procfs guide uses a .c file as example code.
	115	# This requires an explicit dependency
	116	C-procfs-example = procfs_example.xml
	117	C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
	118	$(obj)/procfs-guide.xml: $(C-procfs-example2)
	119
3794f3e8 RD	120	# List of programs to build
	121	##oops, this is a kernel module::hostprogs-y := procfs_example
	122	obj-m += procfs_example.o
	123
	124	# Tell kbuild to always build the programs
	125	always := $(hostprogs-y)
	126
71f95cfb MW	127	notfoundtemplate = echo "* You have to install docbook-utils or xmlto *"; \
	128	exit 1
	129	db2xtemplate = db2TYPE -o $(dir $@) $<
	130	xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
	131
	132	# determine which methods are available
	133	ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
	134	use-db2x = db2x
	135	prefer-db2x = db2x
	136	else
	137	use-db2x = notfound
	138	prefer-db2x = $(use-xmlto)
	139	endif
	140	ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
	141	use-xmlto = xmlto
	142	prefer-xmlto = xmlto
	143	else
	144	use-xmlto = notfound
	145	prefer-xmlto = $(use-db2x)
	146	endif
1da177e4	147
71f95cfb MW	148	# the commands, generated from the chosen template
	149	quiet_cmd_db2ps = PS $@
	150	cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
1da177e4	151	%.ps : %.xml
1da177e4 LT	152	$(call cmd,db2ps)
1da177e4 LT	153
a34645f5	154	quiet_cmd_db2pdf = PDF $@
71f95cfb	155	cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
1da177e4	156	%.pdf : %.xml
1da177e4 LT	157	$(call cmd,db2pdf)
1da177e4 LT	158
eb81d930	159
64e3da10 RD	160	index = index.html
64e3da10 RD	161	main_idx = Documentation/DocBook/$(index)
eb81d930 BP	162	build_main_index = rm -rf $(main_idx) && \
	163	echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
	164	echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
	165	cat $(HTML) >> $(main_idx)
	166
a34645f5	167	quiet_cmd_db2html = HTML $@
8b0c2d98	168	cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
4fa35166	169	echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
eb81d930	170	$(patsubst %.html,%,$(notdir $@))</a><p>' > $@
1da177e4 LT	171
1da177e4 LT	172	%.html: %.xml
8b0c2d98	173	@(which xmlto > /dev/null 2>&1) \|\| \
fd4a3244	174	(echo "* You need to install xmlto *"; \
1da177e4 LT	175	exit 1)
	176	@rm -rf $@ $(patsubst %.html,%,$@)
	177	$(call cmd,db2html)
	178	@if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
	179	cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
	180
71f95cfb	181	quiet_cmd_db2man = MAN $@
8b0c2d98 MW	182	cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
	183	%.9 : %.xml
	184	@(which xmlto > /dev/null 2>&1) \|\| \
fd4a3244	185	(echo "* You need to install xmlto *"; \
8b0c2d98	186	exit 1)
e711db3e	187	$(Q)mkdir -p $(obj)/man
8b0c2d98 MW	188	$(call cmd,db2man)
8b0c2d98 MW	189	@touch $@
1da177e4 LT	190
1da177e4 LT	191	###
0f035b8e	192	# Rules to generate postscripts and PNG images from .fig format files
1da177e4 LT	193	quiet_cmd_fig2eps = FIG2EPS $@
	194	cmd_fig2eps = fig2dev -Leps $< $@
	195
	196	%.eps: %.fig
	197	@(which fig2dev > /dev/null 2>&1) \|\| \
	198	(echo "* You need to install transfig *"; \
	199	exit 1)
	200	$(call cmd,fig2eps)
	201
	202	quiet_cmd_fig2png = FIG2PNG $@
	203	cmd_fig2png = fig2dev -Lpng $< $@
	204
	205	%.png: %.fig
	206	@(which fig2dev > /dev/null 2>&1) \|\| \
	207	(echo "* You need to install transfig *"; \
	208	exit 1)
	209	$(call cmd,fig2png)
	210
	211	###
	212	# Rule to convert a .c file to inline XML documentation
759cd603 MF	213	gen_xml = :
	214	quiet_gen_xml = echo ' GEN $@'
	215	silent_gen_xml = :
1da177e4	216	%.xml: %.c
759cd603	217	@$($(quiet)gen_xml)
1da177e4 LT	218	@( \
	219	echo "<programlisting>"; \
	220	expand --tabs=8 < $< \| \
	221	sed -e "s/&/\\&/g" \
	222	-e "s/</\\</g" \
	223	-e "s/>/\\>/g"; \
	224	echo "</programlisting>") > $@
	225
	226	###
	227	# Help targets as used by the top-level makefile
	228	dochelp:
6fc52f81 JJ	229	@echo ' Linux kernel internal documentation in different formats:'
6fc52f81 JJ	230	@echo ' htmldocs - HTML'
6fc52f81 JJ	231	@echo ' pdfdocs - PDF'
	232	@echo ' psdocs - Postscript'
	233	@echo ' xmldocs - XML DocBook'
2810ae8c RD	234	@echo ' mandocs - man pages'
	235	@echo ' installmandocs - install man pages generated by mandocs'
	236	@echo ' cleandocs - clean all generated DocBook files'
1da177e4 LT	237
	238	###
	239	# Temporary files left by various tools
	240	clean-files := $(DOCBOOKS) \
	241	$(patsubst %.xml, %.dvi, $(DOCBOOKS)) \
	242	$(patsubst %.xml, %.aux, $(DOCBOOKS)) \
	243	$(patsubst %.xml, %.tex, $(DOCBOOKS)) \
	244	$(patsubst %.xml, %.log, $(DOCBOOKS)) \
	245	$(patsubst %.xml, %.out, $(DOCBOOKS)) \
	246	$(patsubst %.xml, %.ps, $(DOCBOOKS)) \
	247	$(patsubst %.xml, %.pdf, $(DOCBOOKS)) \
	248	$(patsubst %.xml, %.html, $(DOCBOOKS)) \
	249	$(patsubst %.xml, %.9, $(DOCBOOKS)) \
64e3da10	250	$(C-procfs-example) $(index)
1da177e4	251
e711db3e	252	clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
4f193362	253
2810ae8c RD	254	cleandocs:
	255	$(Q)rm -f $(call objectify, $(clean-files))
	256	$(Q)rm -rf $(call objectify, $(clean-dirs))
	257
4f193362 PS	258	# Declare the contents of the .PHONY variable as phony. We keep that
	259	# information in a variable se we can use it in if_changed and friends.
	260
	261	.PHONY: $(PHONY)