linux-kernel - Re: [PATCH] [KERNEL-DOC] kill warnings when building mandocs

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]

Message-ID: <20070420060250.GB3967@gollum.tnic>
Date:	Fri, 20 Apr 2007 08:02:50 +0200
From:	Borislav Petkov <bbpetkov@...oo.de>
To:	Randy Dunlap <randy.dunlap@...cle.com>
Cc:	lkml <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] [KERNEL-DOC] kill warnings when building mandocs

On Thu, Apr 19, 2007 at 08:53:36AM -0700, Randy Dunlap wrote:
> On Thu, 19 Apr 2007 08:20:59 +0200 Borislav Petkov wrote:
> 
> > <snip>
> > > > I'm pretty sure the reason you cannot reproduce this warning is the line 
> > > > 
> > > > <xsl:param name="refentry.version.suppress">1</xsl:param>
> > > > 
> > > > which can be found in param.xsl, it being a part of the docbook-xsl
> > > > distribution. The parameter's name is self-explanatory and a '1' suppresses
> > > > the version generation. I was able to get this error because in the
> > > > debian docbook-xsl package this param value is set to 0 by default.
> > > 
> > > Hm, I don't seem to have that file installed (except in
> > > /usr/share/xml/docbook/stylesheet/...).  Where would it normally
> > > be installed?
> > 
> > /usr/share/xml/docbook/stylesheet/nwalsh/manpages/param.xsl here
> 
> OK, I have that one, with a /current/ stuck in there:
> 
> 
> /usr/share/xml/docbook/stylesheet/nwalsh/1.69.1/manpages/param.xsl
> 
> <xsl:param name="refentry.version.suppress">0</xsl:param>

That's why you don't get the warnings.

> > > > This means, some users will get this warning and some will not, depending on the
> > > > setting in the param.xsl file. What is the way to go here wrt to a solution
> > > > dealing with all cases:
> > > > 
> > > > 1. patch the kernel-doc?
> > > > 2. issue an info so that the user can suppress the annoying warning by
> > > > themselves?
> > > > 3. ...?
> > > 
> > > 
> > > Are other people seeing these warning messages ??
> > Hm, is anyone building the manpages target at all?
> 
> Other than the 2 of us... I couldn't say.

By the way, can we consider the item 
"- clean up Documentation/DocBook/, fix warnings that occur on make *docs."  
from the KJ TODO list as now done?
 
> > > If so, I think that we should patch the kernel-doc.  I don't think
> > > that many people would read info about how to avoid the warnings.
> 
> 
> ---
> ~Randy
> *** Remember to use Documentation/SubmitChecklist when testing your code ***

-- 
Regards/Gruß,
    Boris.
-
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/