* [patch] tweak make htmldocs (nochunks and better index).
@ 2007-05-29 19:28 Rob Landley
2007-05-30 4:18 ` Randy Dunlap
2007-05-30 5:12 ` Randy Dunlap
0 siblings, 2 replies; 5+ messages in thread
From: Rob Landley @ 2007-05-29 19:28 UTC (permalink / raw)
To: linux-kernel, linux-doc
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) || \
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [patch] tweak make htmldocs (nochunks and better index).
2007-05-29 19:28 [patch] tweak make htmldocs (nochunks and better index) Rob Landley
@ 2007-05-30 4:18 ` Randy Dunlap
2007-05-30 18:47 ` Rob Landley
2007-05-30 5:12 ` Randy Dunlap
1 sibling, 1 reply; 5+ messages in thread
From: Randy Dunlap @ 2007-05-30 4:18 UTC (permalink / raw)
To: Rob Landley; +Cc: linux-kernel, linux-doc
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 ***
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [patch] tweak make htmldocs (nochunks and better index).
2007-05-29 19:28 [patch] tweak make htmldocs (nochunks and better index) Rob Landley
2007-05-30 4:18 ` Randy Dunlap
@ 2007-05-30 5:12 ` Randy Dunlap
1 sibling, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2007-05-30 5:12 UTC (permalink / raw)
To: Rob Landley; +Cc: linux-kernel, linux-doc
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.
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 ***
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [patch] tweak make htmldocs (nochunks and better index).
2007-05-30 4:18 ` Randy Dunlap
@ 2007-05-30 18:47 ` Rob Landley
2007-05-30 19:28 ` Randy Dunlap
0 siblings, 1 reply; 5+ messages in thread
From: Rob Landley @ 2007-05-30 18:47 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-kernel, linux-doc
On Wednesday 30 May 2007 12:18 am, Randy Dunlap wrote:
> What is <\p> supposed to do?
Sorry, typo. Should be </p> instead. My bad.
As to what it does in a larger sense, "make the xml people happy". Closing
parentheses tags make the various xhtml validators shut up. The main
difference between xhtml and html is that you close all the tags you open. I
can yank it if people prefer it that way.
> 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>
Yeah, that's screwed up. (It looked fine in Konqueror. :) *rummage*...
Here's an updated patch. This time I checked that it looked ok in Firefox
too:
--- git/Documentation/DocBook/Makefile 2007-05-23 16:36:56.000000000 -0400
+++ work/Documentation/DocBook/Makefile 2007-05-30 14:36:49.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) || \
Rob
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [patch] tweak make htmldocs (nochunks and better index).
2007-05-30 18:47 ` Rob Landley
@ 2007-05-30 19:28 ` Randy Dunlap
0 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2007-05-30 19:28 UTC (permalink / raw)
To: Rob Landley; +Cc: linux-kernel, linux-doc
On Wed, 30 May 2007 14:47:41 -0400 Rob Landley wrote:
> On Wednesday 30 May 2007 12:18 am, Randy Dunlap wrote:
> > What is <\p> supposed to do?
>
> Sorry, typo. Should be </p> instead. My bad.
>
> As to what it does in a larger sense, "make the xml people happy". Closing
> parentheses tags make the various xhtml validators shut up. The main
> difference between xhtml and html is that you close all the tags you open. I
> can yank it if people prefer it that way.
>
> > 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>
>
> Yeah, that's screwed up. (It looked fine in Konqueror. :) *rummage*...
>
> Here's an updated patch. This time I checked that it looked ok in Firefox
> too:
Yes, /me too. Thanks.
I still disagree on the use of "nochunks" though.
> --- git/Documentation/DocBook/Makefile 2007-05-23 16:36:56.000000000 -0400
> +++ work/Documentation/DocBook/Makefile 2007-05-30 14:36:49.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) || \
>
> Rob
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2007-05-30 19:30 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-05-29 19:28 [patch] tweak make htmldocs (nochunks and better index) Rob Landley
2007-05-30 4:18 ` Randy Dunlap
2007-05-30 18:47 ` Rob Landley
2007-05-30 19:28 ` Randy Dunlap
2007-05-30 5:12 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox