[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 := wanbook.xml z8530book.xml mcabook.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

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

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)

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


main_idx = Documentation/DocBook/index.html
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  '  installmandocs  - install man pages generated by mandocs'
	@echo  '  mandocs         - man pages'
	@echo  '  pdfdocs         - PDF'
	@echo  '  psdocs          - Postscript'
	@echo  '  xmldocs         - XML DocBook'

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

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

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