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]

Date:	Wed, 18 Apr 2007 10:16:54 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	bbpetkov@...oo.de
Cc:	lkml <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] [KERNEL-DOC] kill warnings when building mandocs

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@...oo.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 ***
-
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/