public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Randy Dunlap <randy.dunlap@oracle.com>
To: Rob Landley <rob@landley.net>
Cc: linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org
Subject: Re: [patch] tweak make htmldocs (nochunks and better index).
Date: Tue, 29 May 2007 21:18:09 -0700	[thread overview]
Message-ID: <20070529211809.d995a5f7.randy.dunlap@oracle.com> (raw)
In-Reply-To: <200705291528.34092.rob@landley.net>

On Tue, 29 May 2007 15:28:33 -0400 Rob Landley wrote:

> Signed-off-by: Rob Landley <rob@landley.net>
> 
> A) The "xmtml-nochunks" version of "make htmldocs" is easier to print.
> 
> B) Update the generated index.html to use the html <title> 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>(.*)</title>.*@\1@p' \
> +			"Documentation/DocBook/$$NAME/$$NAME.html" >> $@ ; \
> +		echo '<\p>' >> $@
>  
>  %.html:	%.xml
>  	@(which xmlto > /dev/null 2>&1) || \
> -

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> 



---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

  reply	other threads:[~2007-05-30  4:13 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-05-29 19:28 [patch] tweak make htmldocs (nochunks and better index) Rob Landley
2007-05-30  4:18 ` Randy Dunlap [this message]
2007-05-30 18:47   ` Rob Landley
2007-05-30 19:28     ` Randy Dunlap
2007-05-30  5:12 ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20070529211809.d995a5f7.randy.dunlap@oracle.com \
    --to=randy.dunlap@oracle.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rob@landley.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox