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

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

[Randy Dunlap]

---
~Randy


--- Original Message ---
> 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?

i'm traveling atm  i'll check on that next week.


> > > > 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.

[PATCH] [KERNEL-DOC] kill warnings when building mandocs

[Borislav Petkov]

This patch shuts warnings of the sort:

make -C /mnt/samsung_200/sam/kernel/trees/21-rc6/build \
	KBUILD_SRC=/mnt/samsung_200/sam/kernel/trees/21-rc6 \
	KBUILD_EXTMOD="" -f /mnt/samsung_200/sam/kernel/trees/21-rc6/Makefile mandocs
make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=scripts/basic
make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=Documentation/DocBook mandocs
  SRCTREE=/mnt/samsung_200/sam/kernel/trees/21-rc6/ /mnt/samsung_200/sam/kernel/trees/21-rc6/build/scripts/basic/docproc doc /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/wanbook.tmpl >Documentation/DocBook/wanbook.xml
  if grep -q refentry Documentation/DocBook/wanbook.xml; then xmlto man -m /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/stylesheet.xsl -o Documentation/DocBook/man Documentation/DocBook/wanbook.xml ; gzip -f Documentation/DocBook/man/*.9; fi
Note: meta version: No productnumber or alternative     sppp_close
Note: meta version: No refmiscinfo@class=version        sppp_close
Note: Writing sppp_close.9
Note: meta version: No productnumber or alternative     sppp_open
Note: meta version: No refmiscinfo@class=version        sppp_open

by adding a RefMiscInfo xml tag in the form of the current kernel version to 
the function, struct and enum definitions in files included by kernel-doc when 
building 'mandocs'.  However, the version string appears truncated on the manpage
due to some constraints in the xml DTD for the man header, I believe, for the
troff output is truncated too.


Signed-off-by: Borislav Petkov <bbpetkov@yahoo.de>

Index: 21-rc6/scripts/kernel-doc
===================================================================
--- 21-rc6.orig/scripts/kernel-doc
+++ 21-rc6/scripts/kernel-doc
@@ -326,6 +326,34 @@ while ($ARGV[0] =~ m/^-(.*)/) {
     }
 }
 
+# get kernel version
+sub get_kernel_version() {
+
+	my $version;
+	open (FILE, "../Makefile") || die "Can't open man kernel Makefile: $!";
+
+	EOF: while (my $line = <FILE>)
+	{
+		if ($line =~ /VERSION\s+=\s+(\d+)/) {
+			$version .= $1;
+			next;
+		}
+		if ($line =~ /PATCHLEVEL\s+=\s+(\d+)/) {
+			$version .= ".$1";
+			next;
+		}
+		if ($line =~ /SUBLEVEL\s+=\s+(\d+)/) {
+			$version .= ".$1";
+			next;
+		}
+		if ($line =~ /EXTRAVERSION\s+=\s+(.*)$/) {
+			$version .= $1;
+			last EOF;
+		}
+	}
+	return $version;
+}
+
 
 # generate a sequence of code that will splice in highlighting information
 # using the s// operator.
@@ -592,6 +620,7 @@ sub output_function_xml(%) {
     print "<refmeta>\n";
     print " <refentrytitle><phrase>".$args{'function'}."</phrase></refentrytitle>\n";
     print " <manvolnum>9</manvolnum>\n";
+    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
     print "</refmeta>\n";
     print "<refnamediv>\n";
     print " <refname>".$args{'function'}."</refname>\n";
@@ -668,6 +697,7 @@ sub output_struct_xml(%) {
     print "<refmeta>\n";
     print " <refentrytitle><phrase>".$args{'type'}." ".$args{'struct'}."</phrase></refentrytitle>\n";
     print " <manvolnum>9</manvolnum>\n";
+    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
     print "</refmeta>\n";
     print "<refnamediv>\n";
     print " <refname>".$args{'type'}." ".$args{'struct'}."</refname>\n";
@@ -752,6 +782,7 @@ sub output_enum_xml(%) {
     print "<refmeta>\n";
     print " <refentrytitle><phrase>enum ".$args{'enum'}."</phrase></refentrytitle>\n";
     print " <manvolnum>9</manvolnum>\n";
+    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
     print "</refmeta>\n";
     print "<refnamediv>\n";
     print " <refname>enum ".$args{'enum'}."</refname>\n";

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

[Borislav Petkov]

Sorry for the improper whitespaces, here's a correct version.

Signed-off-by: Borislav Petkov <bbpetkov@yahoo.de>


Index: 21-rc6/scripts/kernel-doc
===================================================================
--- 21-rc6.orig/scripts/kernel-doc
+++ 21-rc6/scripts/kernel-doc
@@ -326,6 +326,32 @@ while ($ARGV[0] =~ m/^-(.*)/) {
     }
 }
 
+# get kernel version
+sub get_kernel_version() {
+    my $version;
+    open (FILE, "../Makefile") || die "Can't open man kernel Makefile: $!";
+
+    EOF: while (my $line = <FILE>)
+    {
+	if ($line =~ /VERSION\s+=\s+(\d+)/) {
+	     $version .= $1;
+	     next;
+	}
+	if ($line =~ /PATCHLEVEL\s+=\s+(\d+)/) {
+	     $version .= ".$1";
+	     next;
+	}
+	if ($line =~ /SUBLEVEL\s+=\s+(\d+)/) {
+	     $version .= ".$1";
+	     next;
+	}
+	if ($line =~ /EXTRAVERSION\s+=\s+(.*)$/) {
+	     $version .= $1;
+	     last EOF;
+	}
+    }
+    return $version;
+}
 
 # generate a sequence of code that will splice in highlighting information
 # using the s// operator.
@@ -592,6 +618,7 @@ sub output_function_xml(%) {
     print "<refmeta>\n";
     print " <refentrytitle><phrase>".$args{'function'}."</phrase></refentrytitle>\n";
     print " <manvolnum>9</manvolnum>\n";
+    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
     print "</refmeta>\n";
     print "<refnamediv>\n";
     print " <refname>".$args{'function'}."</refname>\n";
@@ -668,6 +695,7 @@ sub output_struct_xml(%) {
     print "<refmeta>\n";
     print " <refentrytitle><phrase>".$args{'type'}." ".$args{'struct'}."</phrase></refentrytitle>\n";
     print " <manvolnum>9</manvolnum>\n";
+    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
     print "</refmeta>\n";
     print "<refnamediv>\n";
     print " <refname>".$args{'type'}." ".$args{'struct'}."</refname>\n";
@@ -752,6 +780,7 @@ sub output_enum_xml(%) {
     print "<refmeta>\n";
     print " <refentrytitle><phrase>enum ".$args{'enum'}."</phrase></refentrytitle>\n";
     print " <manvolnum>9</manvolnum>\n";
+    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
     print "</refmeta>\n";
     print "<refnamediv>\n";
     print " <refname>enum ".$args{'enum'}."</refname>\n";

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

[Randy Dunlap]

On Fri, 13 Apr 2007 11:29:43 +0200 Borislav Petkov wrote:

> Sorry for the improper whitespaces, here's a correct version.
> 
> Signed-off-by: Borislav Petkov <bbpetkov@yahoo.de>
> 
> 
> Index: 21-rc6/scripts/kernel-doc
> ===================================================================
> --- 21-rc6.orig/scripts/kernel-doc
> +++ 21-rc6/scripts/kernel-doc
> @@ -326,6 +326,32 @@ while ($ARGV[0] =~ m/^-(.*)/) {
>      }
>  }
>  
> +# get kernel version
> +sub get_kernel_version() {
> +    my $version;
> +    open (FILE, "../Makefile") || die "Can't open man kernel Makefile: $!";

How are you running scripts/kernel-doc ?
I had to change "../Makefile" to just "Makefile" when using
'make htmldocs;.

> +    EOF: while (my $line = <FILE>)
> +    {
> +	if ($line =~ /VERSION\s+=\s+(\d+)/) {
> +	     $version .= $1;
> +	     next;
> +	}
> +	if ($line =~ /PATCHLEVEL\s+=\s+(\d+)/) {
> +	     $version .= ".$1";
> +	     next;
> +	}
> +	if ($line =~ /SUBLEVEL\s+=\s+(\d+)/) {
> +	     $version .= ".$1";
> +	     next;
> +	}
> +	if ($line =~ /EXTRAVERSION\s+=\s+(.*)$/) {
> +	     $version .= $1;
> +	     last EOF;
> +	}
> +    }
> +    return $version;
> +}
>  
>  # generate a sequence of code that will splice in highlighting information
>  # using the s// operator.
> @@ -592,6 +618,7 @@ sub output_function_xml(%) {
>      print "<refmeta>\n";
>      print " <refentrytitle><phrase>".$args{'function'}."</phrase></refentrytitle>\n";
>      print " <manvolnum>9</manvolnum>\n";
> +    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
>      print "</refmeta>\n";
>      print "<refnamediv>\n";
>      print " <refname>".$args{'function'}."</refname>\n";
> @@ -668,6 +695,7 @@ sub output_struct_xml(%) {
>      print "<refmeta>\n";
>      print " <refentrytitle><phrase>".$args{'type'}." ".$args{'struct'}."</phrase></refentrytitle>\n";
>      print " <manvolnum>9</manvolnum>\n";
> +    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
>      print "</refmeta>\n";
>      print "<refnamediv>\n";
>      print " <refname>".$args{'type'}." ".$args{'struct'}."</refname>\n";
> @@ -752,6 +780,7 @@ sub output_enum_xml(%) {
>      print "<refmeta>\n";
>      print " <refentrytitle><phrase>enum ".$args{'enum'}."</phrase></refentrytitle>\n";
>      print " <manvolnum>9</manvolnum>\n";
> +    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
>      print "</refmeta>\n";
>      print "<refnamediv>\n";
>      print " <refname>enum ".$args{'enum'}."</refname>\n";
> -

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

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

[Borislav Petkov]

On Wed, Apr 18, 2007 at 10:16:54AM -0700, Randy Dunlap wrote:
> On Fri, 13 Apr 2007 11:29:43 +0200 Borislav Petkov wrote:
> 
> > Sorry for the improper whitespaces, here's a correct version.
> > 
> > Signed-off-by: Borislav Petkov <bbpetkov@yahoo.de>
> > 
> > 
> > Index: 21-rc6/scripts/kernel-doc
> > ===================================================================
> > --- 21-rc6.orig/scripts/kernel-doc
> > +++ 21-rc6/scripts/kernel-doc
> > @@ -326,6 +326,32 @@ while ($ARGV[0] =~ m/^-(.*)/) {
> >      }
> >  }
> >  
> > +# get kernel version
> > +sub get_kernel_version() {
> > +    my $version;
> > +    open (FILE, "../Makefile") || die "Can't open man kernel Makefile: $!";
> 
> How are you running scripts/kernel-doc ?
> I had to change "../Makefile" to just "Makefile" when using
> 'make htmldocs;.
I knew this one would come around and bite me in the a**. My cmd is :
make V=1 O=build/  htmldocs > build.log 2>&1

so man is cd-ing into the O=build directory and then the main Makefile is one
level above it. Gonna fix this properly today and get back to you.
> 
> > +    EOF: while (my $line = <FILE>)
> > +    {
> > +	if ($line =~ /VERSION\s+=\s+(\d+)/) {
> > +	     $version .= $1;
> > +	     next;
> > +	}
> > +	if ($line =~ /PATCHLEVEL\s+=\s+(\d+)/) {
> > +	     $version .= ".$1";
> > +	     next;
> > +	}
> > +	if ($line =~ /SUBLEVEL\s+=\s+(\d+)/) {
> > +	     $version .= ".$1";
> > +	     next;
> > +	}
> > +	if ($line =~ /EXTRAVERSION\s+=\s+(.*)$/) {
> > +	     $version .= $1;
> > +	     last EOF;
> > +	}
> > +    }
> > +    return $version;
> > +}
> >  
> >  # generate a sequence of code that will splice in highlighting information
> >  # using the s// operator.
> > @@ -592,6 +618,7 @@ sub output_function_xml(%) {
> >      print "<refmeta>\n";
> >      print " <refentrytitle><phrase>".$args{'function'}."</phrase></refentrytitle>\n";
> >      print " <manvolnum>9</manvolnum>\n";
> > +    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
> >      print "</refmeta>\n";
> >      print "<refnamediv>\n";
> >      print " <refname>".$args{'function'}."</refname>\n";
> > @@ -668,6 +695,7 @@ sub output_struct_xml(%) {
> >      print "<refmeta>\n";
> >      print " <refentrytitle><phrase>".$args{'type'}." ".$args{'struct'}."</phrase></refentrytitle>\n";
> >      print " <manvolnum>9</manvolnum>\n";
> > +    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
> >      print "</refmeta>\n";
> >      print "<refnamediv>\n";
> >      print " <refname>".$args{'type'}." ".$args{'struct'}."</refname>\n";
> > @@ -752,6 +780,7 @@ sub output_enum_xml(%) {
> >      print "<refmeta>\n";
> >      print " <refentrytitle><phrase>enum ".$args{'enum'}."</phrase></refentrytitle>\n";
> >      print " <manvolnum>9</manvolnum>\n";
> > +    print " <refmiscinfo class=\"version\">" . get_kernel_version() . "</refmiscinfo>\n";
> >      print "</refmeta>\n";
> >      print "<refnamediv>\n";
> >      print " <refname>enum ".$args{'enum'}."</refname>\n";
> > -
> 
> ---
> ~Randy
> *** Remember to use Documentation/SubmitChecklist when testing your code ***

-- 
Regards/Gruß,
    Boris.

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

[Randy Dunlap]

On Fri, 13 Apr 2007 11:14:22 +0200 Borislav Petkov wrote:

> This patch shuts warnings of the sort:
> 
> make -C /mnt/samsung_200/sam/kernel/trees/21-rc6/build \
> 	KBUILD_SRC=/mnt/samsung_200/sam/kernel/trees/21-rc6 \
> 	KBUILD_EXTMOD="" -f /mnt/samsung_200/sam/kernel/trees/21-rc6/Makefile mandocs
> make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=scripts/basic
> make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=Documentation/DocBook mandocs
>   SRCTREE=/mnt/samsung_200/sam/kernel/trees/21-rc6/ /mnt/samsung_200/sam/kernel/trees/21-rc6/build/scripts/basic/docproc doc /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/wanbook.tmpl >Documentation/DocBook/wanbook.xml
>   if grep -q refentry Documentation/DocBook/wanbook.xml; then xmlto man -m /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/stylesheet.xsl -o Documentation/DocBook/man Documentation/DocBook/wanbook.xml ; gzip -f Documentation/DocBook/man/*.9; fi
> Note: meta version: No productnumber or alternative     sppp_close
> Note: meta version: No refmiscinfo@class=version        sppp_close
> Note: Writing sppp_close.9
> Note: meta version: No productnumber or alternative     sppp_open
> Note: meta version: No refmiscinfo@class=version        sppp_open
> 
> by adding a RefMiscInfo xml tag in the form of the current kernel version to 
> the function, struct and enum definitions in files included by kernel-doc when 
> building 'mandocs'.  However, the version string appears truncated on the manpage
> due to some constraints in the xml DTD for the man header, I believe, for the
> troff output is truncated too.

Hi Borislav,

I cannot reproduce this error (either, a la the tex error).
Any hints about how I could do so?

Thanks,
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

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

[Borislav Petkov]

On Sat, Apr 14, 2007 at 09:13:41AM -0700, Randy Dunlap wrote:
> On Fri, 13 Apr 2007 11:14:22 +0200 Borislav Petkov wrote:
> 
> > This patch shuts warnings of the sort:
> > 
> > make -C /mnt/samsung_200/sam/kernel/trees/21-rc6/build \
> > 	KBUILD_SRC=/mnt/samsung_200/sam/kernel/trees/21-rc6 \
> > 	KBUILD_EXTMOD="" -f /mnt/samsung_200/sam/kernel/trees/21-rc6/Makefile mandocs
> > make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=scripts/basic
> > make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=Documentation/DocBook mandocs
> >   SRCTREE=/mnt/samsung_200/sam/kernel/trees/21-rc6/ /mnt/samsung_200/sam/kernel/trees/21-rc6/build/scripts/basic/docproc doc /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/wanbook.tmpl >Documentation/DocBook/wanbook.xml
> >   if grep -q refentry Documentation/DocBook/wanbook.xml; then xmlto man -m /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/stylesheet.xsl -o Documentation/DocBook/man Documentation/DocBook/wanbook.xml ; gzip -f Documentation/DocBook/man/*.9; fi
> > Note: meta version: No productnumber or alternative     sppp_close
> > Note: meta version: No refmiscinfo@class=version        sppp_close
> > Note: Writing sppp_close.9
> > Note: meta version: No productnumber or alternative     sppp_open
> > Note: meta version: No refmiscinfo@class=version        sppp_open
> > 
> > by adding a RefMiscInfo xml tag in the form of the current kernel version to 
> > the function, struct and enum definitions in files included by kernel-doc when 
> > building 'mandocs'.  However, the version string appears truncated on the manpage
> > due to some constraints in the xml DTD for the man header, I believe, for the
> > troff output is truncated too.
> 
> Hi Borislav,
> 
> I cannot reproduce this error (either, a la the tex error).
> Any hints about how I could do so?

Hm, this is strange. IIRC, the refmiscinfo version tag is imposed by the docbook
xsl stylesheets for manpages, see
http://www.oasis-open.org/archives/docbook-apps/200508/msg00111.html and
especially the 'man'-section, subsection 'extra2 field.' According to it, 
the stylesheets check several different locations for version info to be put in
the left footer position in the manpage, and if none is found, they simply state
that there's no version info, so this is not an error message but simply a
notification which, if nothing else, annoys while building the mandocs.

The URL cites the changelog of docbook-xsl 1.69.1 and this is also the
version in SLED 10 you're using so you should be getting this, too. I'll
try to dig deeper into this. The relevant packs I use are docbook-xsl:
1.72.0.dfsg.1-1, xmlto: 0.0.18-5.1 on debian unstable. 

-- 
Regards/Gruß, 
Boris.

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

[Borislav Petkov]

On Sun, Apr 15, 2007 at 09:10:50AM +0200, Borislav Petkov wrote:
> On Sat, Apr 14, 2007 at 09:13:41AM -0700, Randy Dunlap wrote:
> > On Fri, 13 Apr 2007 11:14:22 +0200 Borislav Petkov wrote:
> > 
> > > This patch shuts warnings of the sort:
> > > 
> > > make -C /mnt/samsung_200/sam/kernel/trees/21-rc6/build \
> > > 	KBUILD_SRC=/mnt/samsung_200/sam/kernel/trees/21-rc6 \
> > > 	KBUILD_EXTMOD="" -f /mnt/samsung_200/sam/kernel/trees/21-rc6/Makefile mandocs
> > > make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=scripts/basic
> > > make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=Documentation/DocBook mandocs
> > >   SRCTREE=/mnt/samsung_200/sam/kernel/trees/21-rc6/ /mnt/samsung_200/sam/kernel/trees/21-rc6/build/scripts/basic/docproc doc /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/wanbook.tmpl >Documentation/DocBook/wanbook.xml
> > >   if grep -q refentry Documentation/DocBook/wanbook.xml; then xmlto man -m /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/stylesheet.xsl -o Documentation/DocBook/man Documentation/DocBook/wanbook.xml ; gzip -f Documentation/DocBook/man/*.9; fi
> > > Note: meta version: No productnumber or alternative     sppp_close
> > > Note: meta version: No refmiscinfo@class=version        sppp_close
> > > Note: Writing sppp_close.9
> > > Note: meta version: No productnumber or alternative     sppp_open
> > > Note: meta version: No refmiscinfo@class=version        sppp_open
> > > 
> > > by adding a RefMiscInfo xml tag in the form of the current kernel version to 
> > > the function, struct and enum definitions in files included by kernel-doc when 
> > > building 'mandocs'.  However, the version string appears truncated on the manpage
> > > due to some constraints in the xml DTD for the man header, I believe, for the
> > > troff output is truncated too.
> > 
> > Hi Borislav,
> > 
> > I cannot reproduce this error (either, a la the tex error).
> > Any hints about how I could do so?
> 
> Hm, this is strange. IIRC, the refmiscinfo version tag is imposed by the docbook
> xsl stylesheets for manpages, see
> http://www.oasis-open.org/archives/docbook-apps/200508/msg00111.html and
> especially the 'man'-section, subsection 'extra2 field.' According to it, 
> the stylesheets check several different locations for version info to be put in
> the left footer position in the manpage, and if none is found, they simply state
> that there's no version info, so this is not an error message but simply a
> notification which, if nothing else, annoys while building the mandocs.
> 
> The URL cites the changelog of docbook-xsl 1.69.1 and this is also the
> version in SLED 10 you're using so you should be getting this, too. I'll
> try to dig deeper into this. The relevant packs I use are docbook-xsl:
> 1.72.0.dfsg.1-1, xmlto: 0.0.18-5.1 on debian unstable. 

Hi Randi,

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.

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. ...?

-- 
Regards/Gruß,
    Boris.

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

[Randy Dunlap]

On Tue, 17 Apr 2007 12:49:07 +0200 Borislav Petkov wrote:

> On Sun, Apr 15, 2007 at 09:10:50AM +0200, Borislav Petkov wrote:
> > On Sat, Apr 14, 2007 at 09:13:41AM -0700, Randy Dunlap wrote:
> > > On Fri, 13 Apr 2007 11:14:22 +0200 Borislav Petkov wrote:
> > > 
> > > > This patch shuts warnings of the sort:
> > > > 
> > > > make -C /mnt/samsung_200/sam/kernel/trees/21-rc6/build \
> > > > 	KBUILD_SRC=/mnt/samsung_200/sam/kernel/trees/21-rc6 \
> > > > 	KBUILD_EXTMOD="" -f /mnt/samsung_200/sam/kernel/trees/21-rc6/Makefile mandocs
> > > > make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=scripts/basic
> > > > make -f /mnt/samsung_200/sam/kernel/trees/21-rc6/scripts/Makefile.build obj=Documentation/DocBook mandocs
> > > >   SRCTREE=/mnt/samsung_200/sam/kernel/trees/21-rc6/ /mnt/samsung_200/sam/kernel/trees/21-rc6/build/scripts/basic/docproc doc /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/wanbook.tmpl >Documentation/DocBook/wanbook.xml
> > > >   if grep -q refentry Documentation/DocBook/wanbook.xml; then xmlto man -m /mnt/samsung_200/sam/kernel/trees/21-rc6/Documentation/DocBook/stylesheet.xsl -o Documentation/DocBook/man Documentation/DocBook/wanbook.xml ; gzip -f Documentation/DocBook/man/*.9; fi
> > > > Note: meta version: No productnumber or alternative     sppp_close
> > > > Note: meta version: No refmiscinfo@class=version        sppp_close
> > > > Note: Writing sppp_close.9
> > > > Note: meta version: No productnumber or alternative     sppp_open
> > > > Note: meta version: No refmiscinfo@class=version        sppp_open
> > > > 
> > > > by adding a RefMiscInfo xml tag in the form of the current kernel version to 
> > > > the function, struct and enum definitions in files included by kernel-doc when 
> > > > building 'mandocs'.  However, the version string appears truncated on the manpage
> > > > due to some constraints in the xml DTD for the man header, I believe, for the
> > > > troff output is truncated too.
> > > 
> > > Hi Borislav,
> > > 
> > > I cannot reproduce this error (either, a la the tex error).
> > > Any hints about how I could do so?
> > 
> > Hm, this is strange. IIRC, the refmiscinfo version tag is imposed by the docbook
> > xsl stylesheets for manpages, see
> > http://www.oasis-open.org/archives/docbook-apps/200508/msg00111.html and
> > especially the 'man'-section, subsection 'extra2 field.' According to it, 
> > the stylesheets check several different locations for version info to be put in
> > the left footer position in the manpage, and if none is found, they simply state
> > that there's no version info, so this is not an error message but simply a
> > notification which, if nothing else, annoys while building the mandocs.
> > 
> > The URL cites the changelog of docbook-xsl 1.69.1 and this is also the
> > version in SLED 10 you're using so you should be getting this, too. I'll
> > try to dig deeper into this. The relevant packs I use are docbook-xsl:
> > 1.72.0.dfsg.1-1, xmlto: 0.0.18-5.1 on debian unstable. 
> 
> Hi Randi,
> 
> 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?


> 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 ??
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 ***

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

[Borislav Petkov]

<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


> > 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?

> 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.

-- 
Regards/Gruß,
    Boris.

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

[Randy Dunlap]

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>


> > > 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.

> > 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 ***

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

[Borislav Petkov]

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.

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

[Randy Dunlap]

On Fri, 20 Apr 2007 08:02:50 +0200 Borislav Petkov wrote:

> > > > 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?

OK, although a few of them may not be fixed until soon after 2.6.21
is released and pending patches are applied.

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***