kernel-doc: Fix stripping of #define in enums
authorConchúr Navid <conchur@web.de>
Sun, 8 Nov 2015 09:45:23 +0000 (10:45 +0100)
committerJonathan Corbet <corbet@lwn.net>
Fri, 20 Nov 2015 23:13:33 +0000 (16:13 -0700)
The regex to strip single line #define's in enumerations depends on the
fact that the defines are still stored on separate lines. But the
surrounding code already removed newlines and replaced them with
semicolons.

For example a simple input like

    /**
     * enum flags - test flags
     * @flag1: first flag
     * @flag2: second flag
     * @flag3: third flag
     * @flag4: fourth flag
     */
    enum flags {
     flag1 = BIT(0),
     flag2 = BIT(1),
    #define flags_small (flag1 | flag2)
     flag3 = BIT(2),
     flag4 = BIT(3),
    #define flags_big (flag2 | flag3)
    };

resulted in parsing warnings like

    warning: Enum value '#define flags_small (flag1 | flag2);flag3 = BIT(2)' not described in enum 'flags'
    warning: Enum value '#define flags_big (flag2 | flag3);' not described in enum 'flags'

Signed-off-by: Conchúr Navid <conchur@web.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc

index 125b906cd1d4bba50c727b108ead1a3d81e1e302..8313b49b6cd0c196e61db5ad140c8a9d49a8a850 100755 (executable)
@@ -1844,7 +1844,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;