About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / DocBook / Makefile




Custom Search

Based on kernel version 4.3. Page generated on 2015-11-02 12:48 EST.

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 document 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 := z8530book.xml device-drivers.xml \
10		    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
11		    writing_usb_driver.xml networking.xml \
12		    kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
13		    gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
14		    genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
15		    80211.xml debugobjects.xml sh.xml regulator.xml \
16		    alsa-driver-api.xml writing-an-alsa-driver.xml \
17		    tracepoint.xml drm.xml media_api.xml w1.xml \
18		    writing_musb_glue_layer.xml crypto-API.xml iio.xml
19	
20	include Documentation/DocBook/media/Makefile
21	
22	###
23	# The build process is as follows (targets):
24	#              (xmldocs) [by docproc]
25	# file.tmpl --> file.xml +--> file.ps   (psdocs)   [by db2ps or xmlto]
26	#                        +--> file.pdf  (pdfdocs)  [by db2pdf or xmlto]
27	#                        +--> DIR=file  (htmldocs) [by xmlto]
28	#                        +--> man/      (mandocs)  [by xmlto]
29	
30	
31	# for PDF and PS output you can choose between xmlto and docbook-utils tools
32	PDF_METHOD	= $(prefer-db2x)
33	PS_METHOD	= $(prefer-db2x)
34	
35	
36	###
37	# The targets that may be used.
38	PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs cleandocs
39	
40	targets += $(DOCBOOKS)
41	BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
42	xmldocs: $(BOOKS)
43	sgmldocs: xmldocs
44	
45	PS := $(patsubst %.xml, %.ps, $(BOOKS))
46	psdocs: $(PS)
47	
48	PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
49	pdfdocs: $(PDF)
50	
51	HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
52	htmldocs: $(HTML)
53		$(call build_main_index)
54		$(call build_images)
55		$(call install_media_images)
56	
57	MAN := $(patsubst %.xml, %.9, $(BOOKS))
58	mandocs: $(MAN)
59		find $(obj)/man -name '*.9' | xargs gzip -nf
60	
61	installmandocs: mandocs
62		mkdir -p /usr/local/man/man9/
63		find $(obj)/man -name '*.9.gz' -printf '%h %f\n' | \
64			sort -k 2 -k 1 | uniq -f 1 | sed -e 's: :/:' | \
65			xargs install -m 644 -t /usr/local/man/man9/
66	
67	###
68	#External programs used
69	KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref
70	KERNELDOC       = $(srctree)/scripts/kernel-doc
71	DOCPROC         = $(objtree)/scripts/docproc
72	
73	XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl
74	XMLTOFLAGS += --skip-validation
75	
76	###
77	# DOCPROC is used for two purposes:
78	# 1) To generate a dependency list for a .tmpl file
79	# 2) To preprocess a .tmpl file and call kernel-doc with
80	#     appropriate parameters.
81	# The following rules are used to generate the .xml documentation
82	# required to generate the final targets. (ps, pdf, html).
83	quiet_cmd_docproc = DOCPROC $@
84	      cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@
85	define rule_docproc
86		set -e;								\
87	        $(if $($(quiet)cmd_$(1)),echo '  $($(quiet)cmd_$(1))';) 	\
88	        $(cmd_$(1)); 							\
89	        ( 								\
90	          echo 'cmd_$@ := $(cmd_$(1))'; 				\
91	          echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; 		\
92	        ) > $(dir $@).$(notdir $@).cmd
93	endef
94	
95	%.xml: %.tmpl $(KERNELDOC) $(DOCPROC) $(KERNELDOCXMLREF) FORCE
96		$(call if_changed_rule,docproc)
97	
98	# Tell kbuild to always build the programs
99	always := $(hostprogs-y)
100	
101	notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \
102			   exit 1
103	db2xtemplate = db2TYPE -o $(dir $@) $<
104	xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $<
105	
106	# determine which methods are available
107	ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found)
108		use-db2x = db2x
109		prefer-db2x = db2x
110	else
111		use-db2x = notfound
112		prefer-db2x = $(use-xmlto)
113	endif
114	ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found)
115		use-xmlto = xmlto
116		prefer-xmlto = xmlto
117	else
118		use-xmlto = notfound
119		prefer-xmlto = $(use-db2x)
120	endif
121	
122	# the commands, generated from the chosen template
123	quiet_cmd_db2ps = PS      $@
124	      cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
125	%.ps : %.xml
126		$(call cmd,db2ps)
127	
128	quiet_cmd_db2pdf = PDF     $@
129	      cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
130	%.pdf : %.xml
131		$(call cmd,db2pdf)
132	
133	
134	index = index.html
135	main_idx = $(obj)/$(index)
136	build_main_index = rm -rf $(main_idx); \
137			   echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
138			   echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
139			   cat $(HTML) >> $(main_idx)
140	
141	quiet_cmd_db2html = HTML    $@
142	      cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
143			echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
144			$(patsubst %.html,%,$(notdir $@))</a><p>' > $@
145	
146	###
147	# Rules to create an aux XML and .db, and use them to re-process the DocBook XML
148	# to fill internal hyperlinks
149	       gen_aux_xml = :
150	 quiet_gen_aux_xml = echo '  XMLREF  $@'
151	silent_gen_aux_xml = :
152	%.aux.xml: %.xml
153		@$($(quiet)gen_aux_xml)
154		@rm -rf $@
155		@(cat $< | egrep "^<refentry id" | egrep -o "\".*\"" | cut -f 2 -d \" > $<.db)
156		@$(KERNELDOCXMLREF) -db $<.db $< > $@
157	.PRECIOUS: %.aux.xml
158	
159	%.html:	%.aux.xml
160		@(which xmlto > /dev/null 2>&1) || \
161		 (echo "*** You need to install xmlto ***"; \
162		  exit 1)
163		@rm -rf $@ $(patsubst %.html,%,$@)
164		$(call cmd,db2html)
165		@if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
166	            cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi
167	
168	quiet_cmd_db2man = MAN     $@
169	      cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man/$(*F) $< ; fi
170	%.9 : %.xml
171		@(which xmlto > /dev/null 2>&1) || \
172		 (echo "*** You need to install xmlto ***"; \
173		  exit 1)
174		$(Q)mkdir -p $(obj)/man/$(*F)
175		$(call cmd,db2man)
176		@touch $@
177	
178	###
179	# Rules to generate postscripts and PNG images from .fig format files
180	quiet_cmd_fig2eps = FIG2EPS $@
181	      cmd_fig2eps = fig2dev -Leps $< $@
182	
183	%.eps: %.fig
184		@(which fig2dev > /dev/null 2>&1) || \
185		 (echo "*** You need to install transfig ***"; \
186		  exit 1)
187		$(call cmd,fig2eps)
188	
189	quiet_cmd_fig2png = FIG2PNG $@
190	      cmd_fig2png = fig2dev -Lpng $< $@
191	
192	%.png: %.fig
193		@(which fig2dev > /dev/null 2>&1) || \
194		 (echo "*** You need to install transfig ***"; \
195		  exit 1)
196		$(call cmd,fig2png)
197	
198	###
199	# Rule to convert a .c file to inline XML documentation
200	       gen_xml = :
201	 quiet_gen_xml = echo '  GEN     $@'
202	silent_gen_xml = :
203	%.xml: %.c
204		@$($(quiet)gen_xml)
205		@(                            \
206		   echo "<programlisting>";   \
207		   expand --tabs=8 < $< |     \
208		   sed -e "s/&/\\&amp;/g"     \
209		       -e "s/</\\&lt;/g"      \
210		       -e "s/>/\\&gt;/g";     \
211		   echo "</programlisting>")  > $@
212	
213	###
214	# Help targets as used by the top-level makefile
215	dochelp:
216		@echo  ' Linux kernel internal documentation in different formats:'
217		@echo  '  htmldocs        - HTML'
218		@echo  '  pdfdocs         - PDF'
219		@echo  '  psdocs          - Postscript'
220		@echo  '  xmldocs         - XML DocBook'
221		@echo  '  mandocs         - man pages'
222		@echo  '  installmandocs  - install man pages generated by mandocs'
223		@echo  '  cleandocs       - clean all generated DocBook files'
224	
225	###
226	# Temporary files left by various tools
227	clean-files := $(DOCBOOKS) \
228		$(patsubst %.xml, %.dvi,     $(DOCBOOKS)) \
229		$(patsubst %.xml, %.aux,     $(DOCBOOKS)) \
230		$(patsubst %.xml, %.tex,     $(DOCBOOKS)) \
231		$(patsubst %.xml, %.log,     $(DOCBOOKS)) \
232		$(patsubst %.xml, %.out,     $(DOCBOOKS)) \
233		$(patsubst %.xml, %.ps,      $(DOCBOOKS)) \
234		$(patsubst %.xml, %.pdf,     $(DOCBOOKS)) \
235		$(patsubst %.xml, %.html,    $(DOCBOOKS)) \
236		$(patsubst %.xml, %.9,       $(DOCBOOKS)) \
237		$(patsubst %.xml, %.aux.xml, $(DOCBOOKS)) \
238		$(patsubst %.xml, %.xml.db,  $(DOCBOOKS)) \
239		$(patsubst %.xml, %.xml,     $(DOCBOOKS)) \
240		$(index)
241	
242	clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man
243	
244	cleandocs: cleanmediadocs
245		$(Q)rm -f $(call objectify, $(clean-files))
246		$(Q)rm -rf $(call objectify, $(clean-dirs))
247	
248	# Declare the contents of the .PHONY variable as phony.  We keep that
249	# information in a variable se we can use it in if_changed and friends.
250	
251	.PHONY: $(PHONY)
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.