[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 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 w1.xml \
	    writing_musb_glue_layer.xml crypto-API.xml iio.xml

ifeq ($(DOCBOOKS),)

# Skip DocBook build if the user explicitly requested no DOCBOOKS.
.DEFAULT:
	@echo "  SKIP    DocBook $@ target (DOCBOOKS=\"\" specified)."
else
ifneq ($(SPHINXDIRS),)

# Skip DocBook build if the user explicitly requested a sphinx dir
.DEFAULT:
	@echo "  SKIP    DocBook $@ target (SPHINXDIRS specified)."
else


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


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 cmd,build_main_index)

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

installmandocs: mandocs
	mkdir -p /usr/local/man/man9/
	find $(obj)/man -name '*.9.gz' -printf '%h %f\n' | \
		sort -k 2 -k 1 | uniq -f 1 | sed -e 's: :/:' | \
		xargs install -m 644 -t /usr/local/man/man9/

# no-op for the DocBook toolchain
epubdocs:

###
#External programs used
KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref
KERNELDOC       = $(srctree)/scripts/kernel-doc
DOCPROC         = $(objtree)/scripts/docproc
CHECK_LC_CTYPE = $(objtree)/scripts/check-lc_ctype

# Use a fixed encoding - UTF-8 if the C library has support built-in
# or ASCII if not
LC_CTYPE := $(call try-run, LC_CTYPE=C.UTF-8 $(CHECK_LC_CTYPE),C.UTF-8,C)
export LC_CTYPE

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) $(KERNELDOCXMLREF) 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)
quiet_cmd_build_main_index = HTML    $(main_idx)
      cmd_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>' > $@

###
# Rules to create an aux XML and .db, and use them to re-process the DocBook XML
# to fill internal hyperlinks
       gen_aux_xml = :
 quiet_gen_aux_xml = echo '  XMLREF  $@'
silent_gen_aux_xml = :
%.aux.xml: %.xml
	@$($(quiet)gen_aux_xml)
	@rm -rf $@
	@(cat $< | egrep "^<refentry id" | egrep -o "\".*\"" | cut -f 2 -d \" > $<.db)
	@$(KERNELDOCXMLREF) -db $<.db $< > $@
.PRECIOUS: %.aux.xml

%.html:	%.aux.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/$(*F) $< ; fi
%.9 : %.xml
	@(which xmlto > /dev/null 2>&1) || \
	 (echo "*** You need to install xmlto ***"; \
	  exit 1)
	$(Q)mkdir -p $(obj)/man/$(*F)
	$(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>")  > $@

endif # DOCBOOKS=""
endif # SPHINDIR=...

###
# Help targets as used by the top-level makefile
dochelp:
	@echo  ' Linux kernel internal documentation in different formats (DocBook):'
	@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'
	@echo
	@echo  '  make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
	@echo  '  valid values for DOCBOOKS are: $(DOCBOOKS)'
	@echo
	@echo  "  make DOCBOOKS=\"\" [target] Don't generate docs from Docbook"
	@echo  '     This is useful to generate only the ReST docs (Sphinx)'


###
# 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)) \
	$(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \
	$(patsubst %.xml, %.xml.db,  $(DOCBOOKS)) \
	$(patsubst %.xml, %.xml,     $(DOCBOOKS)) \
	$(index)

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

cleandocs:
	$(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 \
c1ece767	17	tracepoint.xml w1.xml \
aab97877	18	writing_musb_glue_layer.xml crypto-API.xml iio.xml
42661299	19
bdf107d8 JN	20	ifeq ($(DOCBOOKS),)
	21
	22	# Skip DocBook build if the user explicitly requested no DOCBOOKS.
	23	.DEFAULT:
	24	@echo " SKIP DocBook $@ target (DOCBOOKS=\"\" specified)."
606b9ac8 MH	25	else
606b9ac8 MH	26	ifneq ($(SPHINXDIRS),)
bdf107d8	27
606b9ac8 MH	28	# Skip DocBook build if the user explicitly requested a sphinx dir
	29	.DEFAULT:
	30	@echo " SKIP DocBook $@ target (SPHINXDIRS specified)."
bdf107d8 JN	31	else
bdf107d8 JN	32
606b9ac8	33
1da177e4 LT	34	###
1da177e4 LT	35	# The build process is as follows (targets):
2ac534bc RD	36	# (xmldocs) [by docproc]
	37	# file.tmpl --> file.xml +--> file.ps (psdocs) [by db2ps or xmlto]
	38	# +--> file.pdf (pdfdocs) [by db2pdf or xmlto]
	39	# +--> DIR=file (htmldocs) [by xmlto]
	40	# +--> man/ (mandocs) [by xmlto]
1da177e4	41
71f95cfb MW	42
	43	# for PDF and PS output you can choose between xmlto and docbook-utils tools
	44	PDF_METHOD = $(prefer-db2x)
	45	PS_METHOD = $(prefer-db2x)
	46
	47
6f89b9c1	48	targets += $(DOCBOOKS)
1da177e4	49	BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
a435600e	50	xmldocs: $(BOOKS)
1da177e4 LT	51	sgmldocs: xmldocs
	52
	53	PS := $(patsubst %.xml, %.ps, $(BOOKS))
	54	psdocs: $(PS)
	55
	56	PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
	57	pdfdocs: $(PDF)
	58
f15a3ccd	59	HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
04893043	60	htmldocs: $(HTML)
e237b657	61	$(call cmd,build_main_index)
1da177e4 LT	62
	63	MAN := $(patsubst %.xml, %.9, $(BOOKS))
	64	mandocs: $(MAN)
32c1735c	65	find $(obj)/man -name '*.9' \| xargs gzip -nf
1da177e4 LT	66
1da177e4 LT	67	installmandocs: mandocs
8b0c2d98	68	mkdir -p /usr/local/man/man9/
9ed71e7a BH	69	find $(obj)/man -name '*.9.gz' -printf '%h %f\n' \| \
	70	sort -k 2 -k 1 \| uniq -f 1 \| sed -e 's: :/:' \| \
	71	xargs install -m 644 -t /usr/local/man/man9/
1da177e4	72
22cba31b JN	73	# no-op for the DocBook toolchain
	74	epubdocs:
	75
1da177e4 LT	76	###
1da177e4 LT	77	#External programs used
5699f871 DCLP	78	KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref
	79	KERNELDOC = $(srctree)/scripts/kernel-doc
	80	DOCPROC = $(objtree)/scripts/docproc
b479bfd0 BH	81	CHECK_LC_CTYPE = $(objtree)/scripts/check-lc_ctype
	82
	83	# Use a fixed encoding - UTF-8 if the C library has support built-in
	84	# or ASCII if not
	85	LC_CTYPE := $(call try-run, LC_CTYPE=C.UTF-8 $(CHECK_LC_CTYPE),C.UTF-8,C)
	86	export LC_CTYPE
8b0c2d98	87
ec3fadd6	88	XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl
82c1e49c	89	XMLTOFLAGS += --skip-validation
1da177e4 LT	90
	91	###
	92	# DOCPROC is used for two purposes:
	93	# 1) To generate a dependency list for a .tmpl file
	94	# 2) To preprocess a .tmpl file and call kernel-doc with
	95	# appropriate parameters.
	96	# The following rules are used to generate the .xml documentation
	97	# required to generate the final targets. (ps, pdf, html).
	98	quiet_cmd_docproc = DOCPROC $@
	99	cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
	100	define rule_docproc
	101	set -e; \
	102	$(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \
	103	$(cmd_$(1)); \
	104	( \
	105	echo 'cmd_$@ := $(cmd_$(1))'; \
	106	echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
	107	) > $(dir $@).$(notdir $@).cmd
	108	endef
	109
5699f871	110	%.xml: %.tmpl $(KERNELDOC) $(DOCPROC) $(KERNELDOCXMLREF) FORCE
1da177e4 LT	111	$(call if_changed_rule,docproc)
1da177e4 LT	112
3794f3e8 RD	113	# Tell kbuild to always build the programs
	114	always := $(hostprogs-y)
	115
71f95cfb MW	116	notfoundtemplate = echo "* You have to install docbook-utils or xmlto *"; \
	117	exit 1
	118	db2xtemplate = db2TYPE -o $(dir $@) $<
	119	xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
	120
	121	# determine which methods are available
	122	ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
	123	use-db2x = db2x
	124	prefer-db2x = db2x
	125	else
	126	use-db2x = notfound
	127	prefer-db2x = $(use-xmlto)
	128	endif
	129	ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
	130	use-xmlto = xmlto
	131	prefer-xmlto = xmlto
	132	else
	133	use-xmlto = notfound
	134	prefer-xmlto = $(use-db2x)
	135	endif
1da177e4	136
71f95cfb MW	137	# the commands, generated from the chosen template
	138	quiet_cmd_db2ps = PS $@
	139	cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
1da177e4	140	%.ps : %.xml
1da177e4 LT	141	$(call cmd,db2ps)
1da177e4 LT	142
a34645f5	143	quiet_cmd_db2pdf = PDF $@
71f95cfb	144	cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
1da177e4	145	%.pdf : %.xml
1da177e4 LT	146	$(call cmd,db2pdf)
1da177e4 LT	147
eb81d930	148
64e3da10	149	index = index.html
ec3fadd6	150	main_idx = $(obj)/$(index)
e237b657 MCC	151	quiet_cmd_build_main_index = HTML $(main_idx)
e237b657 MCC	152	cmd_build_main_index = rm -rf $(main_idx); \
eb81d930 BP	153	echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
	154	echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
	155	cat $(HTML) >> $(main_idx)
	156
a34645f5	157	quiet_cmd_db2html = HTML $@
c4d79a47	158	cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
4fa35166	159	echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
ec3fadd6	160	$(patsubst %.html,%,$(notdir $@))</a><p>' > $@
1da177e4	161
5699f871 DCLP	162	###
	163	# Rules to create an aux XML and .db, and use them to re-process the DocBook XML
	164	# to fill internal hyperlinks
	165	gen_aux_xml = :
	166	quiet_gen_aux_xml = echo ' XMLREF $@'
	167	silent_gen_aux_xml = :
	168	%.aux.xml: %.xml
	169	@$($(quiet)gen_aux_xml)
	170	@rm -rf $@
	171	@(cat $< \| egrep "^<refentry id" \| egrep -o "\".*\"" \| cut -f 2 -d \" > $<.db)
	172	@$(KERNELDOCXMLREF) -db $<.db $< > $@
	173	.PRECIOUS: %.aux.xml
	174
	175	%.html: %.aux.xml
8b0c2d98	176	@(which xmlto > /dev/null 2>&1) \|\| \
fd4a3244	177	(echo "* You need to install xmlto *"; \
1da177e4 LT	178	exit 1)
	179	@rm -rf $@ $(patsubst %.html,%,$@)
	180	$(call cmd,db2html)
	181	@if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
	182	cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
	183
71f95cfb	184	quiet_cmd_db2man = MAN $@
9ed71e7a	185	cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man/$(*F) $< ; fi
8b0c2d98 MW	186	%.9 : %.xml
8b0c2d98 MW	187	@(which xmlto > /dev/null 2>&1) \|\| \
fd4a3244	188	(echo "* You need to install xmlto *"; \
8b0c2d98	189	exit 1)
9ed71e7a	190	$(Q)mkdir -p $(obj)/man/$(*F)
8b0c2d98 MW	191	$(call cmd,db2man)
8b0c2d98 MW	192	@touch $@
1da177e4 LT	193
1da177e4 LT	194	###
0f035b8e	195	# Rules to generate postscripts and PNG images from .fig format files
1da177e4 LT	196	quiet_cmd_fig2eps = FIG2EPS $@
	197	cmd_fig2eps = fig2dev -Leps $< $@
	198
	199	%.eps: %.fig
	200	@(which fig2dev > /dev/null 2>&1) \|\| \
	201	(echo "* You need to install transfig *"; \
	202	exit 1)
	203	$(call cmd,fig2eps)
	204
	205	quiet_cmd_fig2png = FIG2PNG $@
	206	cmd_fig2png = fig2dev -Lpng $< $@
	207
	208	%.png: %.fig
	209	@(which fig2dev > /dev/null 2>&1) \|\| \
	210	(echo "* You need to install transfig *"; \
	211	exit 1)
	212	$(call cmd,fig2png)
	213
	214	###
	215	# Rule to convert a .c file to inline XML documentation
759cd603 MF	216	gen_xml = :
	217	quiet_gen_xml = echo ' GEN $@'
	218	silent_gen_xml = :
1da177e4	219	%.xml: %.c
759cd603	220	@$($(quiet)gen_xml)
1da177e4 LT	221	@( \
	222	echo "<programlisting>"; \
	223	expand --tabs=8 < $< \| \
	224	sed -e "s/&/\\&/g" \
	225	-e "s/</\\</g" \
	226	-e "s/>/\\>/g"; \
	227	echo "</programlisting>") > $@
	228
bdf107d8	229	endif # DOCBOOKS=""
606b9ac8	230	endif # SPHINDIR=...
54721886	231
1da177e4 LT	232	###
	233	# Help targets as used by the top-level makefile
	234	dochelp:
ebc88ef0	235	@echo ' Linux kernel internal documentation in different formats (DocBook):'
6fc52f81	236	@echo ' htmldocs - HTML'
6fc52f81 JJ	237	@echo ' pdfdocs - PDF'
	238	@echo ' psdocs - Postscript'
	239	@echo ' xmldocs - XML DocBook'
2810ae8c RD	240	@echo ' mandocs - man pages'
	241	@echo ' installmandocs - install man pages generated by mandocs'
	242	@echo ' cleandocs - clean all generated DocBook files'
e57f0796	243	@echo
ebc88ef0	244	@echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
e57f0796	245	@echo ' valid values for DOCBOOKS are: $(DOCBOOKS)'
54721886	246	@echo
bdf107d8	247	@echo " make DOCBOOKS=\"\" [target] Don't generate docs from Docbook"
54721886	248	@echo ' This is useful to generate only the ReST docs (Sphinx)'
e57f0796	249
1da177e4 LT	250
	251	###
	252	# Temporary files left by various tools
	253	clean-files := $(DOCBOOKS) \
5699f871 DCLP	254	$(patsubst %.xml, %.dvi, $(DOCBOOKS)) \
	255	$(patsubst %.xml, %.aux, $(DOCBOOKS)) \
	256	$(patsubst %.xml, %.tex, $(DOCBOOKS)) \
	257	$(patsubst %.xml, %.log, $(DOCBOOKS)) \
	258	$(patsubst %.xml, %.out, $(DOCBOOKS)) \
	259	$(patsubst %.xml, %.ps, $(DOCBOOKS)) \
	260	$(patsubst %.xml, %.pdf, $(DOCBOOKS)) \
	261	$(patsubst %.xml, %.html, $(DOCBOOKS)) \
	262	$(patsubst %.xml, %.9, $(DOCBOOKS)) \
	263	$(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \
	264	$(patsubst %.xml, %.xml.db, $(DOCBOOKS)) \
	265	$(patsubst %.xml, %.xml, $(DOCBOOKS)) \
82c1e49c	266	$(index)
1da177e4	267
42661299	268	clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
4f193362	269
43f71d93	270	cleandocs:
2810ae8c RD	271	$(Q)rm -f $(call objectify, $(clean-files))
	272	$(Q)rm -rf $(call objectify, $(clean-dirs))
	273
4f193362 PS	274	# Declare the contents of the .PHONY variable as phony. We keep that
	275	# information in a variable se we can use it in if_changed and friends.
	276
	277	.PHONY: $(PHONY)