diff options
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/Makefile | 48 | ||||
-rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 6 | ||||
-rw-r--r-- | Documentation/DocBook/stylesheet.xsl | 1 |
3 files changed, 36 insertions, 19 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 7018f5c6a447..1c955883cf58 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile | |||
@@ -20,6 +20,12 @@ DOCBOOKS := wanbook.xml z8530book.xml mcabook.xml videobook.xml \ | |||
20 | # +--> DIR=file (htmldocs) | 20 | # +--> DIR=file (htmldocs) |
21 | # +--> man/ (mandocs) | 21 | # +--> man/ (mandocs) |
22 | 22 | ||
23 | |||
24 | # for PDF and PS output you can choose between xmlto and docbook-utils tools | ||
25 | PDF_METHOD = $(prefer-db2x) | ||
26 | PS_METHOD = $(prefer-db2x) | ||
27 | |||
28 | |||
23 | ### | 29 | ### |
24 | # The targets that may be used. | 30 | # The targets that may be used. |
25 | .PHONY: xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs | 31 | .PHONY: xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs |
@@ -93,27 +99,39 @@ C-procfs-example = procfs_example.xml | |||
93 | C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example)) | 99 | C-procfs-example2 = $(addprefix $(obj)/,$(C-procfs-example)) |
94 | $(obj)/procfs-guide.xml: $(C-procfs-example2) | 100 | $(obj)/procfs-guide.xml: $(C-procfs-example2) |
95 | 101 | ||
96 | ### | 102 | notfoundtemplate = echo "*** You have to install docbook-utils or xmlto ***"; \ |
97 | # Rules to generate postscript, PDF and HTML | 103 | exit 1 |
98 | # db2html creates a directory. Generate a html file used for timestamp | 104 | db2xtemplate = db2TYPE -o $(dir $@) $< |
105 | xmltotemplate = xmlto TYPE $(XMLTOFLAGS) -o $(dir $@) $< | ||
106 | |||
107 | # determine which methods are available | ||
108 | ifeq ($(shell which db2ps >/dev/null 2>&1 && echo found),found) | ||
109 | use-db2x = db2x | ||
110 | prefer-db2x = db2x | ||
111 | else | ||
112 | use-db2x = notfound | ||
113 | prefer-db2x = $(use-xmlto) | ||
114 | endif | ||
115 | ifeq ($(shell which xmlto >/dev/null 2>&1 && echo found),found) | ||
116 | use-xmlto = xmlto | ||
117 | prefer-xmlto = xmlto | ||
118 | else | ||
119 | use-xmlto = notfound | ||
120 | prefer-xmlto = $(use-db2x) | ||
121 | endif | ||
99 | 122 | ||
100 | quiet_cmd_db2ps = XMLTO $@ | 123 | # the commands, generated from the chosen template |
101 | cmd_db2ps = xmlto ps $(XMLTOFLAGS) -o $(dir $@) $< | 124 | quiet_cmd_db2ps = PS $@ |
125 | cmd_db2ps = $(subst TYPE,ps, $($(PS_METHOD)template)) | ||
102 | %.ps : %.xml | 126 | %.ps : %.xml |
103 | @(which xmlto > /dev/null 2>&1) || \ | ||
104 | (echo "*** You need to install xmlto ***"; \ | ||
105 | exit 1) | ||
106 | $(call cmd,db2ps) | 127 | $(call cmd,db2ps) |
107 | 128 | ||
108 | quiet_cmd_db2pdf = XMLTO $@ | 129 | quiet_cmd_db2pdf = PDF $@ |
109 | cmd_db2pdf = xmlto pdf $(XMLTOFLAGS) -o $(dir $@) $< | 130 | cmd_db2pdf = $(subst TYPE,pdf, $($(PDF_METHOD)template)) |
110 | %.pdf : %.xml | 131 | %.pdf : %.xml |
111 | @(which xmlto > /dev/null 2>&1) || \ | ||
112 | (echo "*** You need to install xmlto ***"; \ | ||
113 | exit 1) | ||
114 | $(call cmd,db2pdf) | 132 | $(call cmd,db2pdf) |
115 | 133 | ||
116 | quiet_cmd_db2html = XMLTO $@ | 134 | quiet_cmd_db2html = HTML $@ |
117 | cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ | 135 | cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ |
118 | echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ | 136 | echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ |
119 | Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ | 137 | Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ |
@@ -127,7 +145,7 @@ quiet_cmd_db2html = XMLTO $@ | |||
127 | @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ | 145 | @if [ ! -z "$(PNG-$(basename $(notdir $@)))" ]; then \ |
128 | cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi | 146 | cp $(PNG-$(basename $(notdir $@))) $(patsubst %.html,%,$@); fi |
129 | 147 | ||
130 | quiet_cmd_db2man = XMLTO $@ | 148 | quiet_cmd_db2man = MAN $@ |
131 | cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi | 149 | cmd_db2man = if grep -q refentry $<; then xmlto man $(XMLTOFLAGS) -o $(obj)/man $< ; gzip -f $(obj)/man/*.9; fi |
132 | %.9 : %.xml | 150 | %.9 : %.xml |
133 | @(which xmlto > /dev/null 2>&1) || \ | 151 | @(which xmlto > /dev/null 2>&1) || \ |
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index a8316b1a3e3d..096aed62c326 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl | |||
@@ -68,9 +68,7 @@ X!Iinclude/linux/kobject.h | |||
68 | 68 | ||
69 | <sect1><title>Kernel utility functions</title> | 69 | <sect1><title>Kernel utility functions</title> |
70 | !Iinclude/linux/kernel.h | 70 | !Iinclude/linux/kernel.h |
71 | <!-- This needs to clean up to make kernel-doc happy | 71 | !Ekernel/printk.c |
72 | X!Ekernel/printk.c | ||
73 | --> | ||
74 | !Ekernel/panic.c | 72 | !Ekernel/panic.c |
75 | !Ekernel/sys.c | 73 | !Ekernel/sys.c |
76 | !Ekernel/rcupdate.c | 74 | !Ekernel/rcupdate.c |
@@ -388,7 +386,7 @@ X!Edrivers/pnp/system.c | |||
388 | 386 | ||
389 | <chapter id="blkdev"> | 387 | <chapter id="blkdev"> |
390 | <title>Block Devices</title> | 388 | <title>Block Devices</title> |
391 | !Edrivers/block/ll_rw_blk.c | 389 | !Eblock/ll_rw_blk.c |
392 | </chapter> | 390 | </chapter> |
393 | 391 | ||
394 | <chapter id="miscdev"> | 392 | <chapter id="miscdev"> |
diff --git a/Documentation/DocBook/stylesheet.xsl b/Documentation/DocBook/stylesheet.xsl index 64be9f7ee3bb..3ccce886c349 100644 --- a/Documentation/DocBook/stylesheet.xsl +++ b/Documentation/DocBook/stylesheet.xsl | |||
@@ -3,4 +3,5 @@ | |||
3 | <param name="chunk.quietly">1</param> | 3 | <param name="chunk.quietly">1</param> |
4 | <param name="funcsynopsis.style">ansi</param> | 4 | <param name="funcsynopsis.style">ansi</param> |
5 | <param name="funcsynopsis.tabular.threshold">80</param> | 5 | <param name="funcsynopsis.tabular.threshold">80</param> |
6 | <!-- <param name="paper.type">A4</param> --> | ||
6 | </stylesheet> | 7 | </stylesheet> |