threads / discuss / 16569

X-Debbugs-Cc didn't make it to git@vger.kernel.org

Subject: X-Debbugs-Cc didn't make it to git@vger.kernel.org

## tl;dr

10 messages between Dec 3, 2008 and Aug 22, 2010.

replies: 9people: 4as markdown or json

jidanni@jidanni.org· Dec 3, 2008, 01:32 UTC · lore

Bummer, on http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=507475 http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=507476 I used X-Debbugs-Cc, and it says Report forwarded to git@vger.kernel.org but I don't see them here on nntp:gmane.comp.version-control.git . Perhaps they got filtered out?

jidanni@jidanni.org· Dec 11, 2008, 20:29 UTC · re: jidanni@jidanni.org · lore

git-doc CSS dependent, breaks down in text browsers

E.g., pages look like
SYNOPSIS

git-config [<file-option>] [type] [-z|--null] name [value [value_regex]] git-config [<file-option>] [type] --add name value git-config [<file-option>] [type] --replace-all name [value [value_regex]] git-config [<file-option>] [type] [-z| --null] --get name [value_regex] git-config [<file-option>] [type] [-z|--null] --get-all name [value_regex] git-config...

Please see http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=507475 , which was supposed to be forwarded to git@vger.kernel.org but wasn't, apparently.

Jeff King· Dec 12, 2008, 03:33 UTC · re: jidanni@jidanni.org · lore

Re: git-doc CSS dependent, breaks down in text browsers

On Fri, Dec 12, 2008 at 04:29:14AM +0800, jidanni@jidanni.org wrote:
Show 7 quoted lines
> E.g., pages look like
> 
> SYNOPSIS
> 
> git-config [<file-option>] [type] [-z|--null] name [value [value_regex]] git-config [<file-option>] [type] --add name
> value git-config [<file-option>] [type] --replace-all name [value [value_regex]] git-config [<file-option>] [type] [-z|
> --null] --get name [value_regex] git-config [<file-option>] [type] [-z|--null] --get-all name [value_regex] git-config...

I think this is another asciidoc issue, as git merely specifies "verse" format for this section. Probably the most friendly thing to do would be to use

  <pre class="verseblock-content">
instead of
  <div class="verseblock-content">

so that non-CSS browsers fall back to preserving the line boundaries (which is what is making it look so unbearable in your text browser). But it is definitely something to be fixed in asciidoc, not in the git documentation.

-Peff
Jeff King· Dec 12, 2008, 02:30 UTC · re: jidanni@jidanni.org · lore

Re: user-manual.html invalid HTML

On Fri, Dec 12, 2008 at 04:32:15AM +0800, jidanni@jidanni.org wrote:
> Please see http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=507476
> Which it turns out didn't get forwarded to git@vger.kernel.org after all. 
The versions I build locally have:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

in each HTML file, which is added by asciidoc. Maybe the package you are looking at was built with an older version of asciidoc that doesn't do this (I don't actually know the history of this feature, but it seems to me that this is something asciidoc should be doing, not git).

-Peff
jidanni@jidanni.org· Dec 12, 2008, 02:47 UTC · re: Jeff King · lore

Re: user-manual.html invalid HTML

>>>>> "JK" == Jeff King <peff@peff.net> writes:
JK> On Fri, Dec 12, 2008 at 04:32:15AM +0800, jidanni@jidanni.org wrote:
>> Please see http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=507476
>> Which it turns out didn't get forwarded to git@vger.kernel.org after all. 
JK> The versions I build locally have:

JK> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" JK> "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

JK> in each HTML file, which is added by asciidoc. Maybe the package you JK> are looking at was built with an older version of asciidoc that doesn't JK> do this (I don't actually know the history of this feature, but it seems JK> to me that this is something asciidoc should be doing, not git).

JK> -Peff
OK, adding 507476@bugs.debian.org to the CCs.
Jonathan Nieder· Aug 20, 2010, 05:04 UTC · re: jidanni@jidanni.org · lore

Re: user-manual.html invalid HTML

Hi,
Sorry for the long silence.
Jeff King wrote:
> On Fri, Dec 12, 2008 at 04:32:15AM +0800, jidanni@jidanni.org wrote:
[user-manual.html lacks a !DOCTYPE declaration]
Show 10 quoted lines
> 
> The versions I build locally have:
> 
> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
>     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
> 
> in each HTML file, which is added by asciidoc.  Maybe the package you
> are looking at was built with an older version of asciidoc that doesn't
> do this (I don't actually know the history of this feature, but it seems
> to me that this is something asciidoc should be doing, not git).

It looks like the HTML for user-manual.html (unlike the reference manual and other articles) is not generated by asciidoc after all; instead, the rule in Documentation/Makefile uses xsltproc directly to convert the asciidoc-generated XML to HTML.

Apparently the caller is supposed to set the chunker.output.doctype-public parameter. http://www.sagehill.net/docbookxsl/Chunking.html#OutputDoctype

Maybe something as simple as this would work.
-- 8< --
Subject: Documentation: set a !DOCTYPE for user manual

asciidoc already takes care of including a doctype for most of the HTML documentation, but the user manual which is processed with docbook-xsl directly lacks one (at least with Debian docbook-xsl 1.75.2+dfsg-5). This makes it harder to automatically validate the HTML.

Reported-by: 積丹尼 <jidanni@jidanni.org>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
diff --git a/Documentation/docbook.xsl b/Documentation/docbook.xsl
index 9a6912c..da8b05b 100644
--- a/Documentation/docbook.xsl
+++ b/Documentation/docbook.xsl
@@ -1,5 +1,8 @@
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
 		version='1.0'>
  <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"/>
- <xsl:output method="html" encoding="UTF-8" indent="no" />
+ <xsl:output method="html"
+     encoding="UTF-8" indent="no"
+     doctype-public="-//W3C//DTD HTML 4.01//EN"
+     doctype-system="http://www.w3.org/TR/html4/strict.dtd" />
 </xsl:stylesheet>
Jeff King· Aug 21, 2010, 06:21 UTC · re: Jonathan Nieder · lore

Re: user-manual.html invalid HTML

On Fri, Aug 20, 2010 at 12:04:02AM -0500, Jonathan Nieder wrote:
Show 14 quoted lines
> > The versions I build locally have:
> > 
> > <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
> >     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
> > 
> > in each HTML file, which is added by asciidoc.  Maybe the package you
> > are looking at was built with an older version of asciidoc that doesn't
> > do this (I don't actually know the history of this feature, but it seems
> > to me that this is something asciidoc should be doing, not git).
> 
> It looks like the HTML for user-manual.html (unlike the reference
> manual and other articles) is not generated by asciidoc after all;
> instead, the rule in Documentation/Makefile uses xsltproc directly to
> convert the asciidoc-generated XML to HTML.
Thanks for tracking this down.
> Apparently the caller is supposed to set the
> chunker.output.doctype-public parameter.
> http://www.sagehill.net/docbookxsl/Chunking.html#OutputDoctype

Your patch works fine for me, though I am using the exact same toolchain as you. I have no idea if older docbook's will work less well.

> + <xsl:output method="html"
> +     encoding="UTF-8" indent="no"
> +     doctype-public="-//W3C//DTD HTML 4.01//EN"
> +     doctype-system="http://www.w3.org/TR/html4/strict.dtd" />

My asciidoc-generated pages are xhtml. We are using "html/docbook.xsl" from docbook, and now "xhtml", so probably some form of html is right. But is html4 strict right? With nothing else to go on, it seems a good guess to me, but I'm wondering if you actually found the answer somewhere.

Also, while testing your patch, I found and fixed the following buglet:
-- >8 --
Subject: [PATCH] docs: fix Makefile dependency for user manual

We use our custom xsl file to build the user manual, so make sure we depend on it. We don't use it anywhere else, so we can stick it straight in the rule.

Signed-off-by: Jeff King <peff@peff.net>
---
 Documentation/Makefile |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/Documentation/Makefile b/Documentation/Makefile
index a4c4063..e117bc4 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -279,7 +279,7 @@ $(patsubst %,%.html,$(API_DOCS) technical/api-index): %.html : %.txt
 XSLT = docbook.xsl
 XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css
 
-user-manual.html: user-manual.xml
+user-manual.html: user-manual.xml $(XSLT)
 	$(QUIET_XSLTPROC)$(RM) $@+ $@ && \
 	xsltproc $(XSLTOPTS) -o $@+ $(XSLT) $< && \
 	mv $@+ $@
-- 
1.7.2.2.350.g9c7e
jidanni@jidanni.org· Jan 8, 2009, 19:36 UTC · re: jidanni@jidanni.org · lore

Re: X-Debbugs-Cc didn't make it to git@vger.kernel.org

>>>>> "j" == jidanni  <jidanni@jidanni.org> writes:

j> Bummer, on j> http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=507475 j> http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=507476 j> I used X-Debbugs-Cc, and it says Report forwarded to git@vger.kernel.org j> but I don't see them here on nntp:gmane.comp.version-control.git . j> Perhaps they got filtered out?

Why of course, $ git checkout origin/todo $ GET 'http://bugs.debian.org/cgi-bin/bugreport.cgi?msg=2;mbox=yes;bug=507475'|./taboo.perl 43 Delivered-To: submit@bugs.debian.org matches /^[-\w_]*:/ && m!Delivered-To:!

# These are Majordomo's global majordomo.cf as used at # vger.kernel.org.

So forget about any X-Debbugs-Cc reaching any kernel.org list.

← back to recent threads