linux-kernel - Re: [patch] tweak make htmldocs (nochunks and better index).

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Tue, 29 May 2007 22:12:02 -0700
From:	Randy Dunlap <rdunlap@...otime.net>
To:	Rob Landley <rob@...dley.net>
Cc:	linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [patch] tweak make htmldocs (nochunks and better index).

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

> Signed-off-by: Rob Landley <rob@...dley.net>
> 
> 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 <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) || \

(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@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/