[linux-2.6-block.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 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 drm.xml media_api.xml w1.xml \
	    writing_musb_glue_layer.xml crypto-API.xml

include Documentation/DocBook/media/Makefile

###
# 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

targets += $(DOCBOOKS)
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)
	$(call install_media_images)

MAN := $(patsubst %.xml, %.9, $(BOOKS))
mandocs: $(MAN)
	find $(obj)/man -name '*.9' | xargs gzip -f

installmandocs: mandocs
	mkdir -p /usr/local/man/man9/
	install $(obj)/man/*.9.gz /usr/local/man/man9/

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

XMLTOFLAGS = -m $(srctree)/$(src)/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 $(KERNELDOC) $(DOCPROC) FORCE
	$(call if_changed_rule,docproc)

# 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 = $(obj)/$(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 html $(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 $< ; 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

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