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
9 DOCBOOKS
:= wanbook.xml z8530book.xml mcabook.xml videobook.xml \
10 kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
11 procfs-guide.xml writing_usb_driver.xml \
12 sis900.xml kernel-api.xml journal-api.xml lsm.xml usb.xml \
13 gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml
16 # The build process is as follows (targets):
18 # file.tmpl --> file.xml +--> file.ps (psdocs)
19 # +--> file.pdf (pdfdocs)
20 # +--> DIR=file (htmldocs)
24 # for PDF and PS output you can choose between xmlto and docbook-utils tools
25 PDF_METHOD
= $(prefer-db2x
)
26 PS_METHOD
= $(prefer-db2x
)
30 # The targets that may be used.
31 .PHONY
: xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs
33 BOOKS
:= $(addprefix $(obj
)/,$(DOCBOOKS
))
37 PS
:= $(patsubst %.xml
, %.ps
, $(BOOKS
))
40 PDF
:= $(patsubst %.xml
, %.pdf
, $(BOOKS
))
43 HTML
:= $(patsubst %.xml
, %.html
, $(BOOKS
))
46 MAN
:= $(patsubst %.xml
, %.9, $(BOOKS
))
49 installmandocs
: mandocs
50 mkdir
-p
/usr
/local
/man
/man9
/
51 install Documentation
/DocBook
/man
/*.9.gz
/usr
/local
/man
/man9
/
54 #External programs used
55 KERNELDOC
= scripts
/kernel-doc
56 DOCPROC
= scripts
/basic
/docproc
58 XMLTOFLAGS
= -m
$(srctree
)/Documentation
/DocBook
/stylesheet.xsl
59 #XMLTOFLAGS += --skip-validation
62 # DOCPROC is used for two purposes:
63 # 1) To generate a dependency list for a .tmpl file
64 # 2) To preprocess a .tmpl file and call kernel-doc with
65 # appropriate parameters.
66 # The following rules are used to generate the .xml documentation
67 # required to generate the final targets. (ps, pdf, html).
68 quiet_cmd_docproc
= DOCPROC
$@
69 cmd_docproc
= SRCTREE
=$(srctree
)/ $(DOCPROC
) doc
$< >$@
72 $(if
$($(quiet
)cmd_
$(1)),echo
' $($(quiet)cmd_$(1))';) \
75 echo
'cmd_$@ := $(cmd_$(1))'; \
76 echo
$@
: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \
77 ) > $(dir $@
).
$(notdir $@
).cmd
81 $(call if_changed_rule
,docproc
)
84 #Read in all saved dependency files
85 cmd_files
:= $(wildcard $(foreach f
,$(BOOKS
),$(dir $(f
)).
$(notdir $(f
)).cmd
))
92 # Changes in kernel-doc force a rebuild of all documentation
93 $(BOOKS
): $(KERNELDOC
)
96 # procfs guide uses a .c file as example code.
97 # This requires an explicit dependency
98 C-procfs-example
= procfs_example.xml
99 C-procfs-example2
= $(addprefix $(obj
)/,$(C-procfs-example
))
100 $(obj
)/procfs-guide.xml
: $(C-procfs-example2
)
102 notfoundtemplate
= echo
"*** You have to install docbook-utils or xmlto ***"; \
104 db2xtemplate
= db2TYPE
-o
$(dir $@
) $<
105 xmltotemplate
= xmlto TYPE
$(XMLTOFLAGS
) -o
$(dir $@
) $<
107 # determine which methods are available
108 ifeq ($(shell which db2ps
>/dev
/null
2>&1 && echo found
),found
)
113 prefer-db2x
= $(use-xmlto
)
115 ifeq ($(shell which xmlto
>/dev
/null
2>&1 && echo found
),found
)
120 prefer-xmlto
= $(use-db2x
)
123 # the commands, generated from the chosen template
124 quiet_cmd_db2ps
= PS
$@
125 cmd_db2ps
= $(subst TYPE
,ps
, $($(PS_METHOD
)template
))
129 quiet_cmd_db2pdf
= PDF
$@
130 cmd_db2pdf
= $(subst TYPE
,pdf
, $($(PDF_METHOD
)template
))
134 quiet_cmd_db2html
= HTML
$@
135 cmd_db2html
= xmlto xhtml
$(XMLTOFLAGS
) -o
$(patsubst %.html
,%,$@
) $< && \
136 echo
'<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
137 Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
140 @
(which xmlto
> /dev
/null
2>&1) || \
141 (echo
"*** You need to install xmlto ***"; \
143 @
rm -rf
$@
$(patsubst %.html
,%,$@
)
145 @if
[ ! -z
"$(PNG-$(basename $(notdir $@)))" ]; then \
146 cp
$(PNG-
$(basename $(notdir $@
))) $(patsubst %.html
,%,$@
); fi
148 quiet_cmd_db2man
= MAN
$@
149 cmd_db2man
= if grep
-q refentry
$<; then xmlto man
$(XMLTOFLAGS
) -o
$(obj
)/man
$< ; gzip
-f
$(obj
)/man
/*.9; fi
151 @
(which xmlto
> /dev
/null
2>&1) || \
152 (echo
"*** You need to install xmlto ***"; \
158 # Rules to generate postscripts and PNG imgages from .fig format files
159 quiet_cmd_fig2eps
= FIG2EPS
$@
160 cmd_fig2eps
= fig2dev
-Leps
$< $@
163 @
(which fig2dev
> /dev
/null
2>&1) || \
164 (echo
"*** You need to install transfig ***"; \
168 quiet_cmd_fig2png
= FIG2PNG
$@
169 cmd_fig2png
= fig2dev
-Lpng
$< $@
172 @
(which fig2dev
> /dev
/null
2>&1) || \
173 (echo
"*** You need to install transfig ***"; \
178 # Rule to convert a .c file to inline XML documentation
182 echo
"<programlisting>"; \
183 expand
--tabs
=8 < $< | \
184 sed
-e
"s/&/\\&/g" \
187 echo
"</programlisting>") > $@
190 # Help targets as used by the top-level makefile
192 @echo
' Linux kernel internal documentation in different formats:'
193 @echo
' xmldocs (XML DocBook), psdocs (Postscript), pdfdocs (PDF)'
194 @echo
' htmldocs (HTML), mandocs (man pages, use installmandocs to install)'
197 # Temporary files left by various tools
198 clean-files
:= $(DOCBOOKS
) \
199 $(patsubst %.xml
, %.
dvi, $(DOCBOOKS
)) \
200 $(patsubst %.xml
, %.aux
, $(DOCBOOKS
)) \
201 $(patsubst %.xml
, %.
tex, $(DOCBOOKS
)) \
202 $(patsubst %.xml
, %.log
, $(DOCBOOKS
)) \
203 $(patsubst %.xml
, %.out
, $(DOCBOOKS
)) \
204 $(patsubst %.xml
, %.ps
, $(DOCBOOKS
)) \
205 $(patsubst %.xml
, %.pdf
, $(DOCBOOKS
)) \
206 $(patsubst %.xml
, %.html
, $(DOCBOOKS
)) \
207 $(patsubst %.xml
, %.9, $(DOCBOOKS
)) \
210 clean-dirs
:= $(patsubst %.xml
,%,$(DOCBOOKS
))
212 #man put files in man subdir - traverse down