Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 |
Adrian Bunk | 58ef2c4 | 2006-04-01 01:04:59 +0200 | [diff] [blame] | 5 | # to document the SRC - and how to read it. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 6 | # To add a new book the only step required is to add the book to the |
| 7 | # list of DOCBOOKS. |
| 8 | |
| 9 | DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \ |
Jeff Garzik | ac9296f | 2005-05-01 08:59:27 -0700 | [diff] [blame] | 10 | kernel-hacking.xml kernel-locking.xml deviceiobook.xml \ |
Randy Dunlap | bc2cda1 | 2008-02-13 15:03:25 -0800 | [diff] [blame] | 11 | procfs-guide.xml writing_usb_driver.xml networking.xml \ |
Jason Wessel | e3e2aaf | 2008-03-20 13:43:45 -0500 | [diff] [blame] | 12 | kernel-api.xml filesystems.xml lsm.xml usb.xml kgdb.xml \ |
Thomas Gleixner | 11c869e | 2006-06-29 02:24:47 -0700 | [diff] [blame] | 13 | gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \ |
Johannes Berg | dbbea67 | 2008-02-26 14:34:06 +0100 | [diff] [blame] | 14 | genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \ |
Thomas Gleixner | 691cc54 | 2008-04-30 00:55:02 -0700 | [diff] [blame] | 15 | mac80211.xml debugobjects.xml |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 16 | |
| 17 | ### |
| 18 | # The build process is as follows (targets): |
Randy Dunlap | 2ac534b | 2007-07-19 01:48:23 -0700 | [diff] [blame] | 19 | # (xmldocs) [by docproc] |
| 20 | # file.tmpl --> file.xml +--> file.ps (psdocs) [by db2ps or xmlto] |
| 21 | # +--> file.pdf (pdfdocs) [by db2pdf or xmlto] |
| 22 | # +--> DIR=file (htmldocs) [by xmlto] |
| 23 | # +--> man/ (mandocs) [by xmlto] |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 24 | |
Martin Waitz | 71f95cf | 2005-11-13 16:08:15 -0800 | [diff] [blame] | 25 | |
| 26 | # for PDF and PS output you can choose between xmlto and docbook-utils tools |
| 27 | PDF_METHOD = $(prefer-db2x) |
| 28 | PS_METHOD = $(prefer-db2x) |
| 29 | |
| 30 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 31 | ### |
| 32 | # The targets that may be used. |
Paul Smith | 4f19336 | 2006-03-05 17:14:10 -0500 | [diff] [blame] | 33 | PHONY += xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 | |
| 35 | BOOKS := $(addprefix $(obj)/,$(DOCBOOKS)) |
| 36 | xmldocs: $(BOOKS) |
| 37 | sgmldocs: xmldocs |
| 38 | |
| 39 | PS := $(patsubst %.xml, %.ps, $(BOOKS)) |
| 40 | psdocs: $(PS) |
| 41 | |
| 42 | PDF := $(patsubst %.xml, %.pdf, $(BOOKS)) |
| 43 | pdfdocs: $(PDF) |
| 44 | |
Randy Dunlap | f15a3cc | 2007-04-11 08:44:12 -0700 | [diff] [blame] | 45 | HTML := $(sort $(patsubst %.xml, %.html, $(BOOKS))) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | htmldocs: $(HTML) |
Borislav Petkov | eb81d93 | 2007-05-08 00:29:36 -0700 | [diff] [blame] | 47 | $(call build_main_index) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 48 | |
| 49 | MAN := $(patsubst %.xml, %.9, $(BOOKS)) |
| 50 | mandocs: $(MAN) |
| 51 | |
| 52 | installmandocs: mandocs |
Martin Waitz | 8b0c2d9 | 2005-05-01 08:59:27 -0700 | [diff] [blame] | 53 | mkdir -p /usr/local/man/man9/ |
| 54 | install Documentation/DocBook/man/*.9.gz /usr/local/man/man9/ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 55 | |
| 56 | ### |
| 57 | #External programs used |
Mike Frysinger | 829ad75 | 2006-12-29 16:49:07 -0800 | [diff] [blame] | 58 | KERNELDOC = $(srctree)/scripts/kernel-doc |
| 59 | DOCPROC = $(objtree)/scripts/basic/docproc |
Martin Waitz | 8b0c2d9 | 2005-05-01 08:59:27 -0700 | [diff] [blame] | 60 | |
Jiri Slaby | 597f6ee | 2005-06-23 22:05:18 -0700 | [diff] [blame] | 61 | XMLTOFLAGS = -m $(srctree)/Documentation/DocBook/stylesheet.xsl |
Martin Waitz | 2948e57 | 2005-05-01 08:59:27 -0700 | [diff] [blame] | 62 | #XMLTOFLAGS += --skip-validation |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 63 | |
| 64 | ### |
| 65 | # DOCPROC is used for two purposes: |
| 66 | # 1) To generate a dependency list for a .tmpl file |
| 67 | # 2) To preprocess a .tmpl file and call kernel-doc with |
| 68 | # appropriate parameters. |
| 69 | # The following rules are used to generate the .xml documentation |
| 70 | # required to generate the final targets. (ps, pdf, html). |
| 71 | quiet_cmd_docproc = DOCPROC $@ |
| 72 | cmd_docproc = SRCTREE=$(srctree)/ $(DOCPROC) doc $< >$@ |
| 73 | define rule_docproc |
| 74 | set -e; \ |
| 75 | $(if $($(quiet)cmd_$(1)),echo ' $($(quiet)cmd_$(1))';) \ |
| 76 | $(cmd_$(1)); \ |
| 77 | ( \ |
| 78 | echo 'cmd_$@ := $(cmd_$(1))'; \ |
| 79 | echo $@: `SRCTREE=$(srctree) $(DOCPROC) depend $<`; \ |
| 80 | ) > $(dir $@).$(notdir $@).cmd |
| 81 | endef |
| 82 | |
| 83 | %.xml: %.tmpl FORCE |
| 84 | $(call if_changed_rule,docproc) |
| 85 | |
| 86 | ### |
| 87 | #Read in all saved dependency files |
| 88 | cmd_files := $(wildcard $(foreach f,$(BOOKS),$(dir $(f)).$(notdir $(f)).cmd)) |
| 89 | |
| 90 | ifneq ($(cmd_files),) |
| 91 | include $(cmd_files) |
| 92 | endif |
| 93 | |
| 94 | ### |
| 95 | # Changes in kernel-doc force a rebuild of all documentation |
| 96 | $(BOOKS): $(KERNELDOC) |
| 97 | |
| 98 | ### |
| 99 | # procfs guide uses a .c file as example code. |
| 100 | # This requires an explicit dependency |
| 101 | C-procfs-example = procfs_example.xml |
| 102 | C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example)) |
| 103 | $(obj)/procfs-guide.xml: $(C-procfs-example2) |
| 104 | |
Martin Waitz | 71f95cf | 2005-11-13 16:08:15 -0800 | [diff] [blame] | 105 | notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \ |
| 106 | exit 1 |
| 107 | db2xtemplate = db2TYPE -o $(dir $@) $< |
| 108 | xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $< |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | |
Martin Waitz | 71f95cf | 2005-11-13 16:08:15 -0800 | [diff] [blame] | 110 | # determine which methods are available |
| 111 | ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found) |
| 112 | use-db2x = db2x |
| 113 | prefer-db2x = db2x |
| 114 | else |
| 115 | use-db2x = notfound |
| 116 | prefer-db2x = $(use-xmlto) |
| 117 | endif |
| 118 | ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found) |
| 119 | use-xmlto = xmlto |
| 120 | prefer-xmlto = xmlto |
| 121 | else |
| 122 | use-xmlto = notfound |
| 123 | prefer-xmlto = $(use-db2x) |
| 124 | endif |
| 125 | |
| 126 | # the commands, generated from the chosen template |
| 127 | quiet_cmd_db2ps = PS $@ |
| 128 | cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 129 | %.ps : %.xml |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 130 | $(call cmd,db2ps) |
| 131 | |
Martin Waitz | 71f95cf | 2005-11-13 16:08:15 -0800 | [diff] [blame] | 132 | quiet_cmd_db2pdf = PDF $@ |
| 133 | cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 134 | %.pdf : %.xml |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 135 | $(call cmd,db2pdf) |
| 136 | |
Borislav Petkov | eb81d93 | 2007-05-08 00:29:36 -0700 | [diff] [blame] | 137 | |
| 138 | main_idx = Documentation/DocBook/index.html |
| 139 | build_main_index = rm -rf $(main_idx) && \ |
| 140 | echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \ |
| 141 | echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \ |
| 142 | cat $(HTML) >> $(main_idx) |
| 143 | |
Martin Waitz | 71f95cf | 2005-11-13 16:08:15 -0800 | [diff] [blame] | 144 | quiet_cmd_db2html = HTML $@ |
Martin Waitz | 8b0c2d9 | 2005-05-01 08:59:27 -0700 | [diff] [blame] | 145 | cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ |
Martin Waitz | 4fa3516 | 2005-05-01 08:59:28 -0700 | [diff] [blame] | 146 | echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ |
Borislav Petkov | eb81d93 | 2007-05-08 00:29:36 -0700 | [diff] [blame] | 147 | $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 148 | |
| 149 | %.html: %.xml |
Martin Waitz | 8b0c2d9 | 2005-05-01 08:59:27 -0700 | [diff] [blame] | 150 | @(which xmlto > /dev/null 2>&1) || \ |
Sam Ravnborg | fd4a324 | 2005-05-01 08:59:28 -0700 | [diff] [blame] | 151 | (echo "*** You need to install xmlto ***"; \ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 152 | exit 1) |
| 153 | @rm -rf $@ $(patsubst %.html,%,$@) |
| 154 | $(call cmd,db2html) |
| 155 | @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ |
| 156 | cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi |
| 157 | |
Martin Waitz | 71f95cf | 2005-11-13 16:08:15 -0800 | [diff] [blame] | 158 | quiet_cmd_db2man = MAN $@ |
Martin Waitz | 8b0c2d9 | 2005-05-01 08:59:27 -0700 | [diff] [blame] | 159 | cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi |
| 160 | %.9 : %.xml |
| 161 | @(which xmlto > /dev/null 2>&1) || \ |
Sam Ravnborg | fd4a324 | 2005-05-01 08:59:28 -0700 | [diff] [blame] | 162 | (echo "*** You need to install xmlto ***"; \ |
Martin Waitz | 8b0c2d9 | 2005-05-01 08:59:27 -0700 | [diff] [blame] | 163 | exit 1) |
Sam Ravnborg | e711db3 | 2007-04-13 23:07:00 +0200 | [diff] [blame] | 164 | $(Q)mkdir -p $(obj)/man |
Martin Waitz | 8b0c2d9 | 2005-05-01 08:59:27 -0700 | [diff] [blame] | 165 | $(call cmd,db2man) |
| 166 | @touch $@ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 167 | |
| 168 | ### |
Simon Arlott | 0f035b8 | 2007-10-20 01:30:25 +0200 | [diff] [blame] | 169 | # Rules to generate postscripts and PNG images from .fig format files |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | quiet_cmd_fig2eps = FIG2EPS $@ |
| 171 | cmd_fig2eps = fig2dev -Leps $< $@ |
| 172 | |
| 173 | %.eps: %.fig |
| 174 | @(which fig2dev > /dev/null 2>&1) || \ |
| 175 | (echo "*** You need to install transfig ***"; \ |
| 176 | exit 1) |
| 177 | $(call cmd,fig2eps) |
| 178 | |
| 179 | quiet_cmd_fig2png = FIG2PNG $@ |
| 180 | cmd_fig2png = fig2dev -Lpng $< $@ |
| 181 | |
| 182 | %.png: %.fig |
| 183 | @(which fig2dev > /dev/null 2>&1) || \ |
| 184 | (echo "*** You need to install transfig ***"; \ |
| 185 | exit 1) |
| 186 | $(call cmd,fig2png) |
| 187 | |
| 188 | ### |
| 189 | # Rule to convert a .c file to inline XML documentation |
Mike Frysinger | 759cd60 | 2008-03-28 14:30:58 -0700 | [diff] [blame] | 190 | gen_xml = : |
| 191 | quiet_gen_xml = echo ' GEN $@' |
| 192 | silent_gen_xml = : |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 193 | %.xml: %.c |
Mike Frysinger | 759cd60 | 2008-03-28 14:30:58 -0700 | [diff] [blame] | 194 | @$($(quiet)gen_xml) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 195 | @( \ |
| 196 | echo "<programlisting>"; \ |
| 197 | expand --tabs=8 < $< | \ |
| 198 | sed -e "s/&/\\&/g" \ |
| 199 | -e "s/</\\</g" \ |
| 200 | -e "s/>/\\>/g"; \ |
| 201 | echo "</programlisting>") > $@ |
| 202 | |
| 203 | ### |
| 204 | # Help targets as used by the top-level makefile |
| 205 | dochelp: |
Jesper Juhl | 6fc52f8 | 2006-12-07 00:16:26 +0100 | [diff] [blame] | 206 | @echo ' Linux kernel internal documentation in different formats:' |
| 207 | @echo ' htmldocs - HTML' |
| 208 | @echo ' installmandocs - install man pages generated by mandocs' |
| 209 | @echo ' mandocs - man pages' |
| 210 | @echo ' pdfdocs - PDF' |
| 211 | @echo ' psdocs - Postscript' |
| 212 | @echo ' xmldocs - XML DocBook' |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 213 | |
| 214 | ### |
| 215 | # Temporary files left by various tools |
| 216 | clean-files := $(DOCBOOKS) \ |
| 217 | $(patsubst %.xml, %.dvi, $(DOCBOOKS)) \ |
| 218 | $(patsubst %.xml, %.aux, $(DOCBOOKS)) \ |
| 219 | $(patsubst %.xml, %.tex, $(DOCBOOKS)) \ |
| 220 | $(patsubst %.xml, %.log, $(DOCBOOKS)) \ |
| 221 | $(patsubst %.xml, %.out, $(DOCBOOKS)) \ |
| 222 | $(patsubst %.xml, %.ps, $(DOCBOOKS)) \ |
| 223 | $(patsubst %.xml, %.pdf, $(DOCBOOKS)) \ |
| 224 | $(patsubst %.xml, %.html, $(DOCBOOKS)) \ |
| 225 | $(patsubst %.xml, %.9, $(DOCBOOKS)) \ |
| 226 | $(C-procfs-example) |
| 227 | |
Sam Ravnborg | e711db3 | 2007-04-13 23:07:00 +0200 | [diff] [blame] | 228 | clean-dirs := $(patsubst %.xml,%,$(DOCBOOKS)) man |
Paul Smith | 4f19336 | 2006-03-05 17:14:10 -0500 | [diff] [blame] | 229 | |
| 230 | # Declare the contents of the .PHONY variable as phony. We keep that |
| 231 | # information in a variable se we can use it in if_changed and friends. |
| 232 | |
| 233 | .PHONY: $(PHONY) |