[deliverable/linux.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 \
	    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

include $(srctree)/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

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

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
f7f84f38	9	DOCBOOKS := z8530book.xml mcabook.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 \
42661299 MCC	17	tracepoint.xml drm.xml media_api.xml
	18
	19	include $(srctree)/Documentation/DocBook/media/Makefile
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.
42661299	37	PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
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
42661299	231	clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
4f193362	232
42661299	233	cleandocs: cleanmediadocs
2810ae8c RD	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)