linux-kernel - Re: [PATCH v2] kernel-doc: include struct short description in title output

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] [day] [month] [year] [list]

Message-Id: <1171395818.10344.126.camel@johannes.berg>
Date:	Tue, 13 Feb 2007 20:43:38 +0100
From:	Johannes Berg <johannes@...solutions.net>
To:	Randy Dunlap <randy.dunlap@...cle.com>
Cc:	lkml <linux-kernel@...r.kernel.org>, akpm <akpm@...l.org>
Subject: Re: [PATCH v2] kernel-doc: include struct short description in
	title output

On Tue, 2007-02-13 at 11:35 -0800, Randy Dunlap wrote:
> > Yup, that fixes it for structs. I guess I forgot to mention this earlier
> > because I didn't notice it until now... the same bug exists for
> > functions as well.
> 
> updated patch.  Thanks.

Thanks, works great.

> ---
> 
> From: Randy Dunlap <randy.dunlap@...cle.com>
> 
> Output of a function or struct in html mode needs to include the short
> description from the function/struct name line in the output title line.
> 
> Signed-off-by: Randy Dunlap <randy.dunlap@...cle.com>

So if anyone cares:

Acked-by: Johannes Berg <johannes@...solutions.net>

> ---
>  scripts/kernel-doc |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> --- linux-2.6.20-git7.orig/scripts/kernel-doc
> +++ linux-2.6.20-git7/scripts/kernel-doc
> @@ -452,7 +452,7 @@ sub output_struct_html(%) {
>      my %args = %{$_[0]};
>      my ($parameter);
>  
> -    print "<h2>".$args{'type'}." ".$args{'struct'}."</h2>\n";
> +    print "<h2>".$args{'type'}." ".$args{'struct'}. " - " .$args{'purpose'}."</h2>\n";
>      print "<b>".$args{'type'}." ".$args{'struct'}."</b> {<br>\n";
>      foreach $parameter (@{$args{'parameterlist'}}) {
>  	if ($parameter =~ /^#/) {
> @@ -498,8 +498,8 @@ sub output_function_html(%) {
>      my %args = %{$_[0]};
>      my ($parameter, $section);
>      my $count;
> -    print "<h2>Function</h2>\n";
>  
> +    print "<h2>" .$args{'function'}." - ".$args{'purpose'}."</h2>\n";
>      print "<i>".$args{'functiontype'}."</i>\n";
>      print "<b>".$args{'function'}."</b>\n";
>      print "(";
> 

Download attachment "signature.asc" of type "application/pgp-signature" (191 bytes)