Makefile 8.6 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4
###
# 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
A
Adrian Bunk 已提交
5
# to document the SRC - and how to read it.
L
Linus Torvalds 已提交
6 7 8
# To add a new book the only step required is to add the book to the
# list of DOCBOOKS.

9
DOCBOOKS := z8530book.xml  \
10
	    kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
A
Alexey Dobriyan 已提交
11
	    writing_usb_driver.xml networking.xml \
J
Jason Wessel 已提交
12
	    kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \
13
	    gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
J
Johannes Berg 已提交
14
	    genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
15
	    debugobjects.xml sh.xml regulator.xml \
16
	    alsa-driver-api.xml writing-an-alsa-driver.xml \
17
	    tracepoint.xml w1.xml \
18
	    writing_musb_glue_layer.xml crypto-API.xml iio.xml
19

20 21 22 23 24
ifeq ($(DOCBOOKS),)

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

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

33

L
Linus Torvalds 已提交
34 35
###
# The build process is as follows (targets):
36 37 38 39 40
#              (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]
L
Linus Torvalds 已提交
41

42 43 44 45 46 47

# for PDF and PS output you can choose between xmlto and docbook-utils tools
PDF_METHOD	= $(prefer-db2x)
PS_METHOD	= $(prefer-db2x)


48
targets += $(DOCBOOKS)
L
Linus Torvalds 已提交
49
BOOKS := $(addprefix $(obj)/,$(DOCBOOKS))
50
xmldocs: $(BOOKS)
L
Linus Torvalds 已提交
51 52 53 54 55 56 57 58
sgmldocs: xmldocs

PS := $(patsubst %.xml, %.ps, $(BOOKS))
psdocs: $(PS)

PDF := $(patsubst %.xml, %.pdf, $(BOOKS))
pdfdocs: $(PDF)

59
HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS)))
60
htmldocs: $(HTML)
61
	$(call cmd,build_main_index)
L
Linus Torvalds 已提交
62 63 64

MAN := $(patsubst %.xml, %.9, $(BOOKS))
mandocs: $(MAN)
65
	find $(obj)/man -name '*.9' | xargs gzip -nf
L
Linus Torvalds 已提交
66 67

installmandocs: mandocs
68
	mkdir -p /usr/local/man/man9/
69 70 71
	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/
L
Linus Torvalds 已提交
72

73 74
# no-op for the DocBook toolchain
epubdocs:
75
latexdocs:
76

L
Linus Torvalds 已提交
77 78
###
#External programs used
79 80 81
KERNELDOCXMLREF = $(srctree)/scripts/kernel-doc-xml-ref
KERNELDOC       = $(srctree)/scripts/kernel-doc
DOCPROC         = $(objtree)/scripts/docproc
82 83 84 85 86 87
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
88

89
XMLTOFLAGS = -m $(srctree)/$(src)/stylesheet.xsl
A
Alexey Dobriyan 已提交
90
XMLTOFLAGS += --skip-validation
L
Linus Torvalds 已提交
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110

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

111
%.xml: %.tmpl $(KERNELDOC) $(DOCPROC) $(KERNELDOCXMLREF) FORCE
L
Linus Torvalds 已提交
112 113
	$(call if_changed_rule,docproc)

114 115 116
# Tell kbuild to always build the programs
always := $(hostprogs-y)

117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
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
L
Linus Torvalds 已提交
137

138 139 140
# the commands, generated from the chosen template
quiet_cmd_db2ps = PS      $@
      cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template))
L
Linus Torvalds 已提交
141 142 143
%.ps : %.xml
	$(call cmd,db2ps)

144
quiet_cmd_db2pdf = PDF     $@
145
      cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template))
L
Linus Torvalds 已提交
146 147 148
%.pdf : %.xml
	$(call cmd,db2pdf)

149

R
Randy Dunlap 已提交
150
index = index.html
151
main_idx = $(obj)/$(index)
152 153
quiet_cmd_build_main_index = HTML    $(main_idx)
      cmd_build_main_index = rm -rf $(main_idx); \
154 155 156 157
		   echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
		   echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
		   cat $(HTML) >> $(main_idx)

158
quiet_cmd_db2html = HTML    $@
159
      cmd_db2html = xmlto html $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
M
Martin Waitz 已提交
160
		echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
161
		$(patsubst %.html,%,$(notdir $@))</a><p>' > $@
L
Linus Torvalds 已提交
162

163 164 165 166 167 168 169 170 171 172 173 174 175 176
###
# 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
177
	@(which xmlto > /dev/null 2>&1) || \
178
	 (echo "*** You need to install xmlto ***"; \
L
Linus Torvalds 已提交
179 180 181 182 183 184
	  exit 1)
	@rm -rf $@ $(patsubst %.html,%,$@)
	$(call cmd,db2html)
	@if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \
            cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi

185
quiet_cmd_db2man = MAN     $@
186
      cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man/$(*F) $< ; fi
187 188
%.9 : %.xml
	@(which xmlto > /dev/null 2>&1) || \
189
	 (echo "*** You need to install xmlto ***"; \
190
	  exit 1)
191
	$(Q)mkdir -p $(obj)/man/$(*F)
192 193
	$(call cmd,db2man)
	@touch $@
L
Linus Torvalds 已提交
194 195

###
S
Simon Arlott 已提交
196
# Rules to generate postscripts and PNG images from .fig format files
L
Linus Torvalds 已提交
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
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
217 218 219
       gen_xml = :
 quiet_gen_xml = echo '  GEN     $@'
silent_gen_xml = :
L
Linus Torvalds 已提交
220
%.xml: %.c
221
	@$($(quiet)gen_xml)
L
Linus Torvalds 已提交
222 223 224 225 226 227 228 229
	@(                            \
	   echo "<programlisting>";   \
	   expand --tabs=8 < $< |     \
	   sed -e "s/&/\\&amp;/g"     \
	       -e "s/</\\&lt;/g"      \
	       -e "s/>/\\&gt;/g";     \
	   echo "</programlisting>")  > $@

230
endif # DOCBOOKS=""
231
endif # SPHINDIR=...
232

L
Linus Torvalds 已提交
233 234 235
###
# Help targets as used by the top-level makefile
dochelp:
236
	@echo  ' Linux kernel internal documentation in different formats (DocBook):'
237 238 239 240
	@echo  '  htmldocs        - HTML'
	@echo  '  pdfdocs         - PDF'
	@echo  '  psdocs          - Postscript'
	@echo  '  xmldocs         - XML DocBook'
R
Randy Dunlap 已提交
241 242 243
	@echo  '  mandocs         - man pages'
	@echo  '  installmandocs  - install man pages generated by mandocs'
	@echo  '  cleandocs       - clean all generated DocBook files'
244
	@echo
245
	@echo  '  make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
246
	@echo  '  valid values for DOCBOOKS are: $(DOCBOOKS)'
247
	@echo
248
	@echo  "  make DOCBOOKS=\"\" [target] Don't generate docs from Docbook"
249
	@echo  '     This is useful to generate only the ReST docs (Sphinx)'
250

L
Linus Torvalds 已提交
251 252 253 254

###
# Temporary files left by various tools
clean-files := $(DOCBOOKS) \
255 256 257 258 259 260 261 262 263 264 265 266
	$(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)) \
A
Alexey Dobriyan 已提交
267
	$(index)
L
Linus Torvalds 已提交
268

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

271
cleandocs:
R
Randy Dunlap 已提交
272 273 274
	$(Q)rm -f $(call objectify, $(clean-files))
	$(Q)rm -rf $(call objectify, $(clean-dirs))

275 276 277 278
# 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)