[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 ducument 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 videobook.xml \
	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
	    procfs-guide.xml writing_usb_driver.xml scsidrivers.xml \
	    sis900.xml kernel-api.xml journal-api.xml lsm.xml usb.xml \
	    gadget.xml libata.xml mtdnand.xml librs.xml

###
# The build process is as follows (targets):
#              (xmldocs)
# file.tmpl --> file.xml +--> file.ps   (psdocs)
#                        +--> file.pdf  (pdfdocs)
#                        +--> DIR=file  (htmldocs)
#                        +--> man/      (mandocs)

###
# 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 := $(patsubst %.xml, %.html, $(BOOKS))
htmldocs: $(HTML)

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 = scripts/kernel-doc
DOCPROC   = scripts/basic/docproc

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

###
# Rules to generate postscript, PDF and HTML
# db2html creates a directory. Generate a html file used for timestamp

quiet_cmd_db2ps = XMLTO    $@
      cmd_db2ps = xmlto ps $(XMLTOFLAGS) -o $(dir $@) $<
%.ps : %.xml
	@(which xmlto > /dev/null 2>&1) || \
	 (echo "*** You need to install DocBook stylesheets ***"; \
	  exit 1)
	$(call cmd,db2ps)

quiet_cmd_db2pdf = XMLTO   $@
      cmd_db2pdf = xmlto pdf $(XMLTOFLAGS) -o $(dir $@) $<
%.pdf : %.xml
	@(which xmlto > /dev/null 2>&1) || \
	 (echo "*** You need to install DocBook stylesheets ***"; \
	  exit 1)
	$(call cmd,db2pdf)

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

%.html:	%.xml
	@(which xmlto > /dev/null 2>&1) || \
	 (echo "*** You need to install DocBook stylesheets ***"; \
	  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 = XMLTO   $@
      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 DocBook stylesheets ***"; \
	  exit 1)
	$(call cmd,db2man)
	@touch $@

###
# Rules to generate postscripts and PNG imgages 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
%.xml: %.c
	@echo '  GEN     $@'
	@(                            \
	   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  '  xmldocs (XML DocBook), psdocs (Postscript), pdfdocs (PDF)'
	@echo  '  htmldocs (HTML), mandocs (man pages, use installmandocs to install)'

###
# 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 put files in man subdir - traverse down
subdir- := man/
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
	5	# to ducument the SRC - and how to read it.
	6	# To add a new book the only step required is to add the book to the
	7	# list of DOCBOOKS.
	8
	9	DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \
ac9296f9 JG	10	kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
	11	procfs-guide.xml writing_usb_driver.xml scsidrivers.xml \
	12	sis900.xml kernel-api.xml journal-api.xml lsm.xml usb.xml \
1da177e4 LT	13	gadget.xml libata.xml mtdnand.xml librs.xml
	14
	15	###
	16	# The build process is as follows (targets):
	17	# (xmldocs)
	18	# file.tmpl --> file.xml +--> file.ps (psdocs)
	19	# +--> file.pdf (pdfdocs)
	20	# +--> DIR=file (htmldocs)
	21	# +--> man/ (mandocs)
	22
	23	###
	24	# The targets that may be used.
	25	.PHONY: xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs
	26
	27	BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
	28	xmldocs: $(BOOKS)
	29	sgmldocs: xmldocs
	30
	31	PS := $(patsubst %.xml, %.ps, $(BOOKS))
	32	psdocs: $(PS)
	33
	34	PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
	35	pdfdocs: $(PDF)
	36
	37	HTML := $(patsubst %.xml, %.html, $(BOOKS))
	38	htmldocs: $(HTML)
	39
	40	MAN := $(patsubst %.xml, %.9, $(BOOKS))
	41	mandocs: $(MAN)
	42
	43	installmandocs: mandocs
8b0c2d98 MW	44	mkdir -p /usr/local/man/man9/
8b0c2d98 MW	45	install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/
1da177e4 LT	46
	47	###
	48	#External programs used
	49	KERNELDOC = scripts/kernel-doc
	50	DOCPROC = scripts/basic/docproc
8b0c2d98 MW	51
8b0c2d98 MW	52	#XMLTOFLAGS = --skip-validation
1da177e4 LT	53
	54	###
	55	# DOCPROC is used for two purposes:
	56	# 1) To generate a dependency list for a .tmpl file
	57	# 2) To preprocess a .tmpl file and call kernel-doc with
	58	# appropriate parameters.
	59	# The following rules are used to generate the .xml documentation
	60	# required to generate the final targets. (ps, pdf, html).
	61	quiet_cmd_docproc = DOCPROC $@
	62	cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
	63	define rule_docproc
	64	set -e; \
	65	$(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \
	66	$(cmd_$(1)); \
	67	( \
	68	echo 'cmd_$@ := $(cmd_$(1))'; \
	69	echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
	70	) > $(dir $@).$(notdir $@).cmd
	71	endef
	72
	73	%.xml: %.tmpl FORCE
	74	$(call if_changed_rule,docproc)
	75
	76	###
	77	#Read in all saved dependency files
	78	cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd))
	79
	80	ifneq ($(cmd_files),)
	81	include $(cmd_files)
	82	endif
	83
	84	###
	85	# Changes in kernel-doc force a rebuild of all documentation
	86	$(BOOKS): $(KERNELDOC)
	87
	88	###
	89	# procfs guide uses a .c file as example code.
	90	# This requires an explicit dependency
	91	C-procfs-example = procfs_example.xml
	92	C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example))
	93	$(obj)/procfs-guide.xml: $(C-procfs-example2)
	94
	95	###
	96	# Rules to generate postscript, PDF and HTML
	97	# db2html creates a directory. Generate a html file used for timestamp
	98
8b0c2d98 MW	99	quiet_cmd_db2ps = XMLTO $@
8b0c2d98 MW	100	cmd_db2ps = xmlto ps $(XMLTOFLAGS) -o $(dir $@) $<
1da177e4	101	%.ps : %.xml
8b0c2d98	102	@(which xmlto > /dev/null 2>&1) \|\| \
1da177e4 LT	103	(echo "* You need to install DocBook stylesheets *"; \
	104	exit 1)
	105	$(call cmd,db2ps)
	106
8b0c2d98 MW	107	quiet_cmd_db2pdf = XMLTO $@
8b0c2d98 MW	108	cmd_db2pdf = xmlto pdf $(XMLTOFLAGS) -o $(dir $@) $<
1da177e4	109	%.pdf : %.xml
8b0c2d98	110	@(which xmlto > /dev/null 2>&1) \|\| \
1da177e4 LT	111	(echo "* You need to install DocBook stylesheets *"; \
	112	exit 1)
	113	$(call cmd,db2pdf)
	114
8b0c2d98 MW	115	quiet_cmd_db2html = XMLTO $@
8b0c2d98 MW	116	cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
1da177e4 LT	117	echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/book1.html"> \
	118	Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
	119
	120	%.html: %.xml
8b0c2d98	121	@(which xmlto > /dev/null 2>&1) \|\| \
1da177e4 LT	122	(echo "* You need to install DocBook stylesheets *"; \
	123	exit 1)
	124	@rm -rf $@ $(patsubst %.html,%,$@)
	125	$(call cmd,db2html)
	126	@if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
	127	cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
	128
8b0c2d98 MW	129	quiet_cmd_db2man = XMLTO $@
	130	cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi
	131	%.9 : %.xml
	132	@(which xmlto > /dev/null 2>&1) \|\| \
	133	(echo "* You need to install DocBook stylesheets *"; \
	134	exit 1)
	135	$(call cmd,db2man)
	136	@touch $@
1da177e4 LT	137
	138	###
	139	# Rules to generate postscripts and PNG imgages from .fig format files
	140	quiet_cmd_fig2eps = FIG2EPS $@
	141	cmd_fig2eps = fig2dev -Leps $< $@
	142
	143	%.eps: %.fig
	144	@(which fig2dev > /dev/null 2>&1) \|\| \
	145	(echo "* You need to install transfig *"; \
	146	exit 1)
	147	$(call cmd,fig2eps)
	148
	149	quiet_cmd_fig2png = FIG2PNG $@
	150	cmd_fig2png = fig2dev -Lpng $< $@
	151
	152	%.png: %.fig
	153	@(which fig2dev > /dev/null 2>&1) \|\| \
	154	(echo "* You need to install transfig *"; \
	155	exit 1)
	156	$(call cmd,fig2png)
	157
	158	###
	159	# Rule to convert a .c file to inline XML documentation
	160	%.xml: %.c
	161	@echo ' GEN $@'
	162	@( \
	163	echo "<programlisting>"; \
	164	expand --tabs=8 < $< \| \
	165	sed -e "s/&/\\&/g" \
	166	-e "s/</\\</g" \
	167	-e "s/>/\\>/g"; \
	168	echo "</programlisting>") > $@
	169
	170	###
	171	# Help targets as used by the top-level makefile
	172	dochelp:
	173	@echo ' Linux kernel internal documentation in different formats:'
	174	@echo ' xmldocs (XML DocBook), psdocs (Postscript), pdfdocs (PDF)'
	175	@echo ' htmldocs (HTML), mandocs (man pages, use installmandocs to install)'
	176
	177	###
	178	# Temporary files left by various tools
	179	clean-files := $(DOCBOOKS) \
	180	$(patsubst %.xml, %.dvi, $(DOCBOOKS)) \
	181	$(patsubst %.xml, %.aux, $(DOCBOOKS)) \
	182	$(patsubst %.xml, %.tex, $(DOCBOOKS)) \
	183	$(patsubst %.xml, %.log, $(DOCBOOKS)) \
	184	$(patsubst %.xml, %.out, $(DOCBOOKS)) \
	185	$(patsubst %.xml, %.ps, $(DOCBOOKS)) \
	186	$(patsubst %.xml, %.pdf, $(DOCBOOKS)) \
	187	$(patsubst %.xml, %.html, $(DOCBOOKS)) \
	188	$(patsubst %.xml, %.9, $(DOCBOOKS)) \
	189	$(C-procfs-example)
	190
	191	clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS))
	192
	193	#man put files in man subdir - traverse down
	194	subdir- := man/