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

Commit 4468e21e authored by Conchúr Navid's avatar Conchúr Navid Committed by Jonathan Corbet
Browse files

kernel-doc: Strip #ifdef/#endif in enums 



Some enumerations in the kernel headers use #ifdef to reduce their size
based on the the configuration. These lines have to be stripped to avoid
parsing problems.

For example a simple input like

    /**
     * enum flags - test flags
     * @flag1: first flag
     * @flag2: second flag
     */
    enum flags {
    	flag1 = BIT(0),
    #ifdef SECOND_FLAG
    	flag2 = BIT(1),
    #endif
    };

resulted in parsing warnings like

    warning: Enum value '#ifdef SECOND_FLAG;flag2 = BIT(1)' not described in enum 'flags'
    warning: Enum value '#endif;' 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 8a9260aa

scripts/kernel-doc

+2 −1
Original line number Diff line number Diff line
@@ -1844,7 +1844,8 @@ sub dump_enum($$) { 
    my $file = shift;



    $x =~ s@/\*.*?\*/@@gos;	# strip comments.

    $x =~ s@#\s*define\s+[^;]*;@@gos; # strip #define macros inside enums

    # strip #define macros inside enums

    $x =~ s@#\s*((define|ifdef)\s+|endif)[^;]*;@@gos;



    if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {

	$declaration_name = $1;