[PATCH] [KERNEL-DOC] generate main index page when building 'htmldocs'

From: Borislav Petkov
Date: Tue Apr 10 2007 - 19:44:55 EST


Here's a patch for kernel-doc that enables the generation of a global, TOC-like index.html
page after building 'htmldocs'

Signed-off-by: Borislav Petkov <bbpetkov@xxxxxxxx>


Index: 21-rc6/Documentation/DocBook/Makefile
===================================================================
--- 21-rc6.orig/Documentation/DocBook/Makefile 2007-04-11 00:02:02.000000000 +0200
+++ 21-rc6/Documentation/DocBook/Makefile 2007-04-11 01:00:21.000000000 +0200
@@ -44,6 +44,7 @@

HTML := $(patsubst %.xml, %.html, $(BOOKS))
htmldocs: $(HTML)
+ $(call build_main_index)

MAN := $(patsubst %.xml, %.9, $(BOOKS))
mandocs: $(MAN)
@@ -133,10 +134,17 @@
%.pdf : %.xml
$(call cmd,db2pdf)

+
+main_idx = Documentation/DocBook/index.html
+build_main_index = rm -rf $(main_idx) && \
+ echo '<h1>Linux Kernel HTML Documentation</h1>' >> $(main_idx) && \
+ echo '<h2>Kernel Version: $(KERNELVERSION)</h2>' >> $(main_idx) && \
+ cat $(HTML) >> $(main_idx)
+
quiet_cmd_db2html = HTML $@
cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \
echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \
- Goto $(patsubst %.html,%,$(notdir $@))</a><p>' > $@
+ $(patsubst %.html,%,$(notdir $@))</a><p>' > $@

%.html: %.xml
@(which xmlto > /dev/null 2>&1) || \
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/