kernel-doc: Not stripped #define/#ifdef/#endif in enums

kernel-doc: Not stripped #define/#ifdef/#endif in enums

[conchur]

Hi,
 
just noticed that #define in kernel-doc are not correctly stripped anymore from enums. Here is my patch

 
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1830,7 +1830,7 @@ sub dump_enum($$) {
     my $file = shift;
 
     $x =~ s@/\*.*?\*/@@gos;	# strip comments.
-    $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums
+    $x =~ s@#\s*define\s+[^;]*;@@gos; # strip #define macros inside enums
 
     if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
 	$declaration_name = $1;

 
But there are also places in the kernel where #ifdef/#endif is used inside enums. So maybe this should also be stripped:

--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1830,7 +1830,8 @@ sub dump_enum($$) {
     my $file = shift;
 
     $x =~ s@/\*.*?\*/@@gos;	# strip comments.
-    $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums
+    # strip #define/#ifdef/#endif macros inside enums
+    $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;
 
     if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
 	$declaration_name = $1;

Re: kernel-doc: Not stripped #define/#ifdef/#endif in enums

[Jonathan Corbet]

On Sun, 1 Nov 2015 17:20:11 +0100
conchur@web.de wrote:

> just noticed that #define in kernel-doc are not correctly stripped
> anymore from enums. Here is my patch

Thanks for your patches, but I can't apply them in their current form.
Could you please do me a favor and:

 - Include changelogs that say why the changes are being made - what is
   the problem with how things are now?

 - Include a proper signoff.  See Documentation/SubmittingPatches for
   details.

You can probably trim the CC list somewhat the next time around as well.

Thanks,

jon

Aw: Re: kernel-doc: Not stripped #define/#ifdef/#endif in enums

[conchur]

> > just noticed that #define in kernel-doc are not correctly stripped
> > anymore from enums. Here is my patch
> 
> Thanks for your patches, but I can't apply them in their current form.
> Could you please do me a favor and:
> 
> - Include changelogs that say why the changes are being made - what is
> the problem with how things are now?
> 
> - Include a proper signoff. See Documentation/SubmittingPatches for
> details.
> 
> You can probably trim the CC list somewhat the next time around as well.

I did all that but now my patches were just ignored.

Re: kernel-doc: Not stripped #define/#ifdef/#endif in enums

[Jonathan Corbet]

On Fri, 20 Nov 2015 12:27:54 +0100
conchur@web.de wrote:

> I did all that but now my patches were just ignored.

They arrived during the merge window and were put into my docs folder for
further consideration.  I've not yet started my 4.5 branch - been a bit
busy, sorry - but will look at them when I do.  That could happen as soon
as today.

jon

Aw: Re: kernel-doc: Not stripped #define/#ifdef/#endif in enums

[conchur]

> > I did all that but now my patches were just ignored.
> 
> They arrived during the merge window and were put into my docs folder for
> further consideration. I've not yet started my 4.5 branch - been a bit
> busy, sorry - but will look at them when I do. That could happen as soon
> as today.

Ah, ok - thanks