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