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