lkml.org 
[lkml]   [2007]   [Apr]   [11]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    /
    Date
    From
    SubjectRe: [PATCH] [KERNEL-DOC] generate main index page when building 'htmldocs'
    On Wed, 11 Apr 2007 01:44:22 +0200 Borislav Petkov wrote:

    > 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@yahoo.de>

    Acked-by: Randy Dunlap <randy.dunlap@oracle.com>

    Nice idea. However, the order of entries in index.html is suboptimal,
    due to the order of DOCBOOKS in the Makefile. You could submit a patch
    for that, or I'll change it.

    Thanks.


    > 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) || \
    > -

    ---
    ~Randy
    *** Remember to use Documentation/SubmitChecklist when testing your code ***
    -
    To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
    the body of a message to majordomo@vger.kernel.org
    More majordomo info at http://vger.kernel.org/majordomo-info.html
    Please read the FAQ at http://www.tux.org/lkml/

    \
     
     \ /
      Last update: 2007-04-11 06:21    [W:0.024 / U:60.108 seconds]
    ©2003-2016 Jasper Spaans. hosted at Digital OceanAdvertise on this site