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
9 ifeq ($(IGNORE_DOCBOOKS
),)
11 DOCBOOKS
:= z8530book.xml device-drivers.xml \
12 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
13 writing_usb_driver.xml networking.xml \
14 kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
15 gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
16 genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
17 80211.xml debugobjects.xml sh.xml regulator.xml \
18 alsa-driver-api.xml writing-an-alsa-driver.xml \
19 tracepoint.xml gpu.xml media_api.xml w1.xml \
20 writing_musb_glue_layer.xml crypto-API.xml iio.xml
22 include Documentation
/DocBook
/media
/Makefile
25 # The build process is as follows (targets):
26 # (xmldocs) [by docproc]
27 # file.tmpl --> file.xml +--> file.ps (psdocs) [by db2ps or xmlto]
28 # +--> file.pdf (pdfdocs) [by db2pdf or xmlto]
29 # +--> DIR=file (htmldocs) [by xmlto]
30 # +--> man/ (mandocs) [by xmlto]
33 # for PDF and PS output you can choose between xmlto and docbook-utils tools
34 PDF_METHOD
= $(prefer-db2x
)
35 PS_METHOD
= $(prefer-db2x
)
38 targets
+= $(DOCBOOKS
)
39 BOOKS
:= $(addprefix $(obj
)/,$(DOCBOOKS
))
43 PS
:= $(patsubst %.xml
, %.ps
, $(BOOKS
))
46 PDF
:= $(patsubst %.xml
, %.pdf
, $(BOOKS
))
49 HTML
:= $(sort $(patsubst %.xml
, %.html
, $(BOOKS
)))
51 $(call cmd
,build_main_index
)
52 $(call install_media_images
)
54 MAN
:= $(patsubst %.xml
, %.9, $(BOOKS
))
56 find
$(obj
)/man
-name
'*.9' | xargs gzip
-nf
58 installmandocs
: mandocs
59 mkdir
-p
/usr
/local
/man
/man9
/
60 find
$(obj
)/man
-name
'*.9.gz' -printf
'%h %f\n' | \
61 sort -k
2 -k
1 | uniq
-f
1 | sed
-e
's: :/:' | \
62 xargs
install -m
644 -t
/usr
/local
/man
/man9
/
64 # no-op for the DocBook toolchain
68 #External programs used
69 KERNELDOCXMLREF
= $(srctree
)/scripts
/kernel-doc-xml-ref
70 KERNELDOC
= $(srctree
)/scripts
/kernel-doc
71 DOCPROC
= $(objtree
)/scripts
/docproc
72 CHECK_LC_CTYPE
= $(objtree
)/scripts
/check-lc_ctype
74 # Use a fixed encoding - UTF-8 if the C library has support built-in
76 LC_CTYPE
:= $(call try-run
, LC_CTYPE
=C.UTF-8
$(CHECK_LC_CTYPE
),C.UTF-8
,C
)
79 XMLTOFLAGS
= -m
$(srctree
)/$(src
)/stylesheet.xsl
80 XMLTOFLAGS
+= --skip-validation
83 # DOCPROC is used for two purposes:
84 # 1) To generate a dependency list for a .tmpl file
85 # 2) To preprocess a .tmpl file and call kernel-doc with
86 # appropriate parameters.
87 # The following rules are used to generate the .xml documentation
88 # required to generate the final targets. (ps, pdf, html).
89 quiet_cmd_docproc
= DOCPROC
$@
90 cmd_docproc
= SRCTREE
=$(srctree
)/ $(DOCPROC
) doc
$< >$@
93 $(if
$($(quiet
)cmd_
$(1)),echo
' $($(quiet)cmd_$(1))';) \
96 echo
'cmd_$@ := $(cmd_$(1))'; \
97 echo
$@
: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
98 ) > $(dir $@
).
$(notdir $@
).cmd
101 %.xml
: %.tmpl
$(KERNELDOC
) $(DOCPROC
) $(KERNELDOCXMLREF
) FORCE
102 $(call if_changed_rule
,docproc
)
104 # Tell kbuild to always build the programs
105 always
:= $(hostprogs-y
)
107 notfoundtemplate
= echo
"*** You have to install docbook-utils or xmlto ***"; \
109 db2xtemplate
= db2TYPE
-o
$(dir $@
) $<
110 xmltotemplate
= xmlto TYPE
$(XMLTOFLAGS
) -o
$(dir $@
) $<
112 # determine which methods are available
113 ifeq ($(shell which db2ps
>/dev
/null
2>&1 && echo found
),found
)
118 prefer-db2x
= $(use-xmlto
)
120 ifeq ($(shell which xmlto
>/dev
/null
2>&1 && echo found
),found
)
125 prefer-xmlto
= $(use-db2x
)
128 # the commands, generated from the chosen template
129 quiet_cmd_db2ps
= PS
$@
130 cmd_db2ps
= $(subst TYPE
,ps
, $($(PS_METHOD
)template
))
134 quiet_cmd_db2pdf
= PDF
$@
135 cmd_db2pdf
= $(subst TYPE
,pdf
, $($(PDF_METHOD
)template
))
141 main_idx
= $(obj
)/$(index
)
142 quiet_cmd_build_main_index
= HTML
$(main_idx
)
143 cmd_build_main_index
= rm -rf
$(main_idx
); \
144 echo
'<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx
) && \
145 echo
'<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx
) && \
146 cat
$(HTML
) >> $(main_idx
)
148 quiet_cmd_db2html
= HTML
$@
149 cmd_db2html
= xmlto html
$(XMLTOFLAGS
) -o
$(patsubst %.html
,%,$@
) $< && \
150 echo
'<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
151 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
154 # Rules to create an aux XML and .db, and use them to re-process the DocBook XML
155 # to fill internal hyperlinks
157 quiet_gen_aux_xml
= echo
' XMLREF $@'
158 silent_gen_aux_xml
= :
160 @
$($(quiet
)gen_aux_xml
)
162 @
(cat
$< | egrep
"^<refentry id" | egrep
-o
"\".*\"" | cut
-f
2 -d
\" > $<.db
)
163 @
$(KERNELDOCXMLREF
) -db
$<.db
$< > $@
167 @
(which xmlto
> /dev
/null
2>&1) || \
168 (echo
"*** You need to install xmlto ***"; \
170 @
rm -rf
$@
$(patsubst %.html
,%,$@
)
172 @if
[ ! -z
"$(PNG-$(basename $(notdir $@)))" ]; then \
173 cp
$(PNG-
$(basename $(notdir $@
))) $(patsubst %.html
,%,$@
); fi
175 quiet_cmd_db2man
= MAN
$@
176 cmd_db2man
= if grep
-q refentry
$<; then xmlto man
$(XMLTOFLAGS
) -o
$(obj
)/man
/$(*F
) $< ; fi
178 @
(which xmlto
> /dev
/null
2>&1) || \
179 (echo
"*** You need to install xmlto ***"; \
181 $(Q
)mkdir
-p
$(obj
)/man
/$(*F
)
186 # Rules to generate postscripts and PNG images from .fig format files
187 quiet_cmd_fig2eps
= FIG2EPS
$@
188 cmd_fig2eps
= fig2dev
-Leps
$< $@
191 @
(which fig2dev
> /dev
/null
2>&1) || \
192 (echo
"*** You need to install transfig ***"; \
196 quiet_cmd_fig2png
= FIG2PNG
$@
197 cmd_fig2png
= fig2dev
-Lpng
$< $@
200 @
(which fig2dev
> /dev
/null
2>&1) || \
201 (echo
"*** You need to install transfig ***"; \
206 # Rule to convert a .c file to inline XML documentation
208 quiet_gen_xml
= echo
' GEN $@'
213 echo
"<programlisting>"; \
214 expand
--tabs
=8 < $< | \
215 sed
-e
"s/&/\\&/g" \
218 echo
"</programlisting>") > $@
222 # Needed, due to cleanmediadocs
223 include Documentation
/DocBook
/media
/Makefile
231 endif # IGNORE_DOCBOOKS
235 # Help targets as used by the top-level makefile
237 @echo
' Linux kernel internal documentation in different formats (DocBook):'
238 @echo
' htmldocs - HTML'
239 @echo
' pdfdocs - PDF'
240 @echo
' psdocs - Postscript'
241 @echo
' xmldocs - XML DocBook'
242 @echo
' mandocs - man pages'
243 @echo
' installmandocs - install man pages generated by mandocs'
244 @echo
' cleandocs - clean all generated DocBook files'
246 @echo
' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
247 @echo
' valid values for DOCBOOKS are: $(DOCBOOKS)'
249 @echo
" make IGNORE_DOCBOOKS=1 [target] Don't generate docs from Docbook"
250 @echo
' This is useful to generate only the ReST docs (Sphinx)'
254 # Temporary files left by various tools
255 clean-files
:= $(DOCBOOKS
) \
256 $(patsubst %.xml
, %.
dvi, $(DOCBOOKS
)) \
257 $(patsubst %.xml
, %.aux
, $(DOCBOOKS
)) \
258 $(patsubst %.xml
, %.
tex, $(DOCBOOKS
)) \
259 $(patsubst %.xml
, %.log
, $(DOCBOOKS
)) \
260 $(patsubst %.xml
, %.out
, $(DOCBOOKS
)) \
261 $(patsubst %.xml
, %.ps
, $(DOCBOOKS
)) \
262 $(patsubst %.xml
, %.pdf
, $(DOCBOOKS
)) \
263 $(patsubst %.xml
, %.html
, $(DOCBOOKS
)) \
264 $(patsubst %.xml
, %.9, $(DOCBOOKS
)) \
265 $(patsubst %.xml
, %.aux.xml
, $(DOCBOOKS
)) \
266 $(patsubst %.xml
, %.xml.db
, $(DOCBOOKS
)) \
267 $(patsubst %.xml
, %.xml
, $(DOCBOOKS
)) \
270 clean-dirs
:= $(patsubst %.xml
,%,$(DOCBOOKS
)) man
272 cleandocs
: cleanmediadocs
273 $(Q
)rm -f
$(call objectify
, $(clean-files
))
274 $(Q
)rm -rf
$(call objectify
, $(clean-dirs
))
276 # Declare the contents of the .PHONY variable as phony. We keep that
277 # information in a variable se we can use it in if_changed and friends.