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 := 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)/scripts/kernel-doc 55DOCPROC = $(objtree)/scripts/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: $(UBOOTVERSION)</h2>' >> $(main_idx) && \ 135 cat $(HTML) >> $(main_idx) 136 137quiet_cmd_db2html = HTML $@ 138 cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ 139 echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ 140 $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ 141 142%.html: %.xml 143 @(which xmlto > /dev/null 2>&1) || \ 144 (echo "*** You need to install xmlto ***"; \ 145 exit 1) 146 @rm -rf $@ $(patsubst %.html,%,$@) 147 $(call cmd,db2html) 148 @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ 149 cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi 150 151quiet_cmd_db2man = MAN $@ 152 cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi 153%.9 : %.xml 154 @(which xmlto > /dev/null 2>&1) || \ 155 (echo "*** You need to install xmlto ***"; \ 156 exit 1) 157 $(Q)mkdir -p $(obj)/man 158 $(call cmd,db2man) 159 @touch $@ 160 161### 162# Rules to generate postscripts and PNG images from .fig format files 163quiet_cmd_fig2eps = FIG2EPS $@ 164 cmd_fig2eps = fig2dev -Leps $< $@ 165 166%.eps: %.fig 167 @(which fig2dev > /dev/null 2>&1) || \ 168 (echo "*** You need to install transfig ***"; \ 169 exit 1) 170 $(call cmd,fig2eps) 171 172quiet_cmd_fig2png = FIG2PNG $@ 173 cmd_fig2png = fig2dev -Lpng $< $@ 174 175%.png: %.fig 176 @(which fig2dev > /dev/null 2>&1) || \ 177 (echo "*** You need to install transfig ***"; \ 178 exit 1) 179 $(call cmd,fig2png) 180 181### 182# Rule to convert a .c file to inline XML documentation 183 gen_xml = : 184 quiet_gen_xml = echo ' GEN $@' 185silent_gen_xml = : 186%.xml: %.c 187 @$($(quiet)gen_xml) 188 @( \ 189 echo "<programlisting>"; \ 190 expand --tabs=8 < $< | \ 191 sed -e "s/&/\\&/g" \ 192 -e "s/</\\</g" \ 193 -e "s/>/\\>/g"; \ 194 echo "</programlisting>") > $@ 195 196### 197# Help targets as used by the top-level makefile 198dochelp: 199 @echo ' U-Boot bootloader internal documentation in different formats:' 200 @echo ' htmldocs - HTML' 201 @echo ' pdfdocs - PDF' 202 @echo ' psdocs - Postscript' 203 @echo ' xmldocs - XML DocBook' 204 @echo ' mandocs - man pages' 205 @echo ' installmandocs - install man pages generated by mandocs' 206 @echo ' cleandocs - clean all generated DocBook files' 207 208### 209# Temporary files left by various tools 210clean-files := $(DOCBOOKS) \ 211 $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \ 212 $(patsubst %.xml, %.aux, $(DOCBOOKS)) \ 213 $(patsubst %.xml, %.tex, $(DOCBOOKS)) \ 214 $(patsubst %.xml, %.log, $(DOCBOOKS)) \ 215 $(patsubst %.xml, %.out, $(DOCBOOKS)) \ 216 $(patsubst %.xml, %.ps, $(DOCBOOKS)) \ 217 $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \ 218 $(patsubst %.xml, %.html, $(DOCBOOKS)) \ 219 $(patsubst %.xml, %.9, $(DOCBOOKS)) \ 220 $(index) 221 222clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man 223 224cleandocs: 225 $(Q)rm -f $(call objectify, $(clean-files)) 226 $(Q)rm -rf $(call objectify, $(clean-dirs)) 227 228# Declare the contents of the .PHONY variable as phony. We keep that 229# information in a variable se we can use it in if_changed and friends. 230 231.PHONY: $(PHONY) 232