Bug 312907 - Broken XInclude in manpage (breaks formatting)
Summary: Broken XInclude in manpage (breaks formatting)
Status: RESOLVED DUPLICATE of bug 315959
Alias: None
Product: valgrind
Classification: Developer tools
Component: general (show other bugs)
Version: 3.9.0.SVN
Platform: Debian testing Linux
: NOR normal
Target Milestone: ---
Assignee: Julian Seward
URL: http://bugs.debian.org/696694
Keywords:
Depends on:
Blocks:
 
Reported: 2013-01-08 20:42 UTC by Samuel Bronson
Modified: 2013-03-26 10:06 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In:


Attachments
Proposed patch (953 bytes, patch)
2013-01-08 20:53 UTC, Samuel Bronson
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Samuel Bronson 2013-01-08 20:42:36 UTC
I originally reported this as <http://bugs.debian.org/696694>:

Package: valgrind
Version: 1:3.7.0-6
Severity: normal

Dear Maintainer,

This piece of valgrind(1):

,----
| SGCHECK OPTIONS
|        <xi:include></xi:include>.SH "BBV OPTIONS"
`----

which is represented in valgrind.1 as:

,----
| .SH "SGCHECK OPTIONS"
| <xi:include></xi:include>.SH "BBV OPTIONS"
`----

is broken so badly that it screws up the headings.

This is caused by an attempt to XInclude an element which is commented
out, combined with the docbook-xsl manpage stylesheets not handling
failed XIncludes.  Here are the offending passages:

,----[ doc/xml/valgrind-manpage.xml ]
| <refsect1 id="sgcheck-options">
| <title>SGcheck Options</title>
| 
| <xi:include href="../../exp-sgcheck/docs/sg-manual.xml" 
|             xpointer="sg.opts.list"
|             xmlns:xi="http://www.w3.org/2001/XInclude" />
| 
| </refsect1>
`----

,----[ exp-sgcheck/docs/sg-manual.xml ]
| <sect1 id="sg-manual.options" xreflabel="SGCheck Command-line Options">
| <title>SGCheck Command-line Options</title>
| 
| <para>There are no SGCheck-specific command-line options at present.</para>
| <!--
| <para>SGCheck-specific command-line options are:</para>
| 
| 
| <variablelist id="sg.opts.list">
| </variablelist>
| -->
`----


(I reported the problem with docbook-xsl as
<http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=694510> some time ago,
and then forgot to report where I'd actually run into it...)
Comment 1 Samuel Bronson 2013-01-08 20:53:02 UTC
Created attachment 76319 [details]
Proposed patch

Find attached a proposed fix for this, which has been accepted by the Debian maintainer for valgrind (but not yet included in any Debian release).
Comment 2 Julian Seward 2013-03-26 10:06:57 UTC
Apparently fixed in r13323.

*** This bug has been marked as a duplicate of bug 315959 ***