Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8a9260aa authored by Conchúr Navid's avatar Conchúr Navid Committed by Jonathan Corbet
Browse files

kernel-doc: Fix stripping of #define in enums 



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: default avatarConchúr Navid <conchur@web.de>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 8005c49d

scripts/kernel-doc

+1 −1
Original line number Diff line number Diff line
@@ -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;