[mirror_ubuntu-hirsute-kernel.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

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)
	$(if $(wildcard $(obj)/man/*.9),gzip -f $(obj)/man/*.9)

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