LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH] kernel-doc: include struct short description in title output
@ 2007-02-13 19:10 Randy Dunlap
  2007-02-13 19:18 ` Johannes Berg
  0 siblings, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2007-02-13 19:10 UTC (permalink / raw)
  To: johannes; +Cc: lkml, akpm

From: Randy Dunlap <randy.dunlap@oracle.com>

Output of a struct in html mode needs to include the short description
from the struct name line in the output title line.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 scripts/kernel-doc |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- 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 =~ /^#/) {

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] kernel-doc: include struct short description in title output
  2007-02-13 19:10 [PATCH] kernel-doc: include struct short description in title output Randy Dunlap
@ 2007-02-13 19:18 ` Johannes Berg
  2007-02-13 19:35   ` [PATCH v2] " Randy Dunlap
  0 siblings, 1 reply; 4+ messages in thread
From: Johannes Berg @ 2007-02-13 19:18 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: lkml, akpm

[-- Attachment #1: Type: text/plain, Size: 561 bytes --]

On Tue, 2007-02-13 at 11:10 -0800, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Output of a struct in html mode needs to include the short description
> from the struct name line in the output title line.

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.

And apparently I never looked at the output for my description for
pm_set_ops.... maybe (hopefully!) it'll teach me to be more careful next
time.

johannes

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 190 bytes --]

^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH v2] kernel-doc: include struct short description in title output
  2007-02-13 19:18 ` Johannes Berg
@ 2007-02-13 19:35   ` Randy Dunlap
  2007-02-13 19:43     ` Johannes Berg
  0 siblings, 1 reply; 4+ messages in thread
From: Randy Dunlap @ 2007-02-13 19:35 UTC (permalink / raw)
  To: Johannes Berg; +Cc: lkml, akpm

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

From: Randy Dunlap <randy.dunlap@oracle.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@oracle.com>
---
 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 "(";

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH v2] kernel-doc: include struct short description in title output
  2007-02-13 19:35   ` [PATCH v2] " Randy Dunlap
@ 2007-02-13 19:43     ` Johannes Berg
  0 siblings, 0 replies; 4+ messages in thread
From: Johannes Berg @ 2007-02-13 19:43 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: lkml, akpm

[-- Attachment #1: Type: text/plain, Size: 1629 bytes --]

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@oracle.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@oracle.com>

So if anyone cares:

Acked-by: Johannes Berg <johannes@sipsolutions.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 "(";
> 

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 190 bytes --]

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2007-02-13 19:43 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2007-02-13 19:10 [PATCH] kernel-doc: include struct short description in title output Randy Dunlap
2007-02-13 19:18 ` Johannes Berg
2007-02-13 19:35   ` [PATCH v2] " Randy Dunlap
2007-02-13 19:43     ` Johannes Berg

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).