]> git.karo-electronics.de Git - linux-beck.git/commit
kernel-doc: Strip #ifdef/#endif in enums
authorConchúr Navid <conchur@web.de>
Sun, 8 Nov 2015 09:48:05 +0000 (10:48 +0100)
committerJonathan Corbet <corbet@lwn.net>
Fri, 20 Nov 2015 23:13:48 +0000 (16:13 -0700)
commit4468e21eed2dd7ee8dc91d94dbd2ccb0d291fb07
tree29755f76a7435df66b52beee7cfc11cbf55efae7
parent8a9260aa96b5112856a8bfdbf80984bfbcb4003f
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: Conchúr Navid <conchur@web.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc