lkml.org 
[lkml]   [2007]   [Apr]   [20]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCHv2] [KERNEL-DOC] kill warnings when building mandocs
On Thu, Apr 19, 2007 at 09:21:22AM -0700, Randy Dunlap wrote:
> On Thu, 19 Apr 2007 09:19:32 +0200 Borislav Petkov wrote:
>
> > A fixed version of the patch shutting up missing version warnings when building
> > mandocs.
>
> http://www.zip.com.au/~akpm/linux/patches/stuff/tpp.txt ::
> Please include a full patch description/changelog in the future.
will do

> > +sub get_kernel_version() {
> > + my $version;
> > + open (FILE, $ENV{"SRCTREE"}."Makefile") || die "Can't open main kernel Makefile: $!";
>
> This needs to handle the environment variable not
> being there, as another location in scripts/kernel-doc does.
> Updated patch below. Is this OK with you?
yep, this one is fine.

> -----
>
> From: Borislav Petkov <bbpetkov@yahoo.de>
>
> 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>
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
> ---
>
> scripts/kernel-doc | 36 ++++++++++++++++++++++++++++++++++++
> 1 file changed, 36 insertions(+)
>
> --- linux-2621-rc7.orig/scripts/kernel-doc
> +++ linux-2621-rc7/scripts/kernel-doc
> @@ -326,6 +326,39 @@ while ($ARGV[0] =~ m/^-(.*)/) {
> }
> }
>
> +# get kernel version
> +sub get_kernel_version() {
> + my $version;
> + my $mkfile;
> + if (defined($ENV{'srctree'})) {
> + $mkfile = "$ENV{'srctree'}" . "/Makefile";
> + }
> + else {
> + $mkfile = "Makefile";
> + }
> + open (FILE, "$mkfile") || die "Can't open main 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 +625,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 +702,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 +787,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";

--
Regards/Gruß,
Boris.
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

\
 
 \ /
  Last update: 2007-04-20 08:03    [W:0.190 / U:0.096 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site