Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751937AbXE3FF1 (ORCPT ); Wed, 30 May 2007 01:05:27 -0400 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1750933AbXE3FFN (ORCPT ); Wed, 30 May 2007 01:05:13 -0400 Received: from xenotime.net ([66.160.160.81]:57030 "HELO xenotime.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with SMTP id S1749667AbXE3FFL (ORCPT ); Wed, 30 May 2007 01:05:11 -0400 Date: Tue, 29 May 2007 22:12:02 -0700 From: Randy Dunlap To: Rob Landley Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org Subject: Re: [patch] tweak make htmldocs (nochunks and better index). Message-Id: <20070529221202.8aef10bf.rdunlap@xenotime.net> In-Reply-To: <200705291528.34092.rob@landley.net> References: <200705291528.34092.rob@landley.net> Organization: YPO4 X-Mailer: Sylpheed 2.3.1 (GTK+ 2.8.10; x86_64-unknown-linux-gnu) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org X-Mailing-List: linux-kernel@vger.kernel.org Content-Length: 2387 Lines: 71 On Tue, 29 May 2007 15:28:33 -0400 Rob Landley wrote: > Signed-off-by: Rob Landley > > A) The "xmtml-nochunks" version of "make htmldocs" is easier to print. and makes it darn near impossible to print one page or function if that's all that someone is interested in. I'd prefer to leave the html output in separate files and use pdf or ps output for printing entire files. But that's just my take on it. > B) Update the generated index.html to use the html as a > description for each file it links to. > > -- > > --- git/Documentation/DocBook/Makefile 2007-05-23 16:36:56.000000000 -0400 > +++ work/Documentation/DocBook/Makefile 2007-05-26 23:11:36.000000000 -0400 > @@ -141,9 +141,12 @@ > cat $(HTML) >> $(main_idx) > > quiet_cmd_db2html = HTML $@ > - cmd_db2html = xmlto xhtml $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ > - echo '<a HREF="$(patsubst %.html,%,$(notdir $@))/index.html"> \ > - $(patsubst %.html,%,$(notdir $@))</a><p>' > $@ > + cmd_db2html = xmlto xhtml-nochunks $(XMLTOFLAGS) -o $(patsubst %.html,%,$@) $< && \ > + NAME='$(patsubst %.html,%,$(notdir $@))'; \ > + echo -n "<p><a HREF=\"$$NAME/$$NAME.html\">$$NAME</a>" > $@ ; \ > + sed -nre 's@.*<title>(.*).*@\1@p' \ > + "Documentation/DocBook/$$NAME/$$NAME.html" >> $@ ; \ > + echo '<\p>' >> $@ > %.html: %.xml > @(which xmlto > /dev/null 2>&1) || \ (repeating due to email bounced/rejected when from @oracle.com:) What is <\p> supposed to do? Here's what I see in index.html (beginning lines of it): Linux Kernel HTML Documentation Kernel Version: 2.6.22-rc3 deviceiobookBus-Independent Device Accesses <\p> filesystemsLinux Filesystems API <\p> gadgetUSB Gadget API for Linux <\p> genericirqLinux generic IRQ handling <\p> kernel-apiThe Linux Kernel API <\p> kernel-hackingUnreliable Guide To Hacking The Linux Kernel <\p> kernel-lockingUnreliable Guide To Locking <\p> --- so it looks like it could use a space after the short name/before the long name/title, and fix the <\p>. --- ~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/