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