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

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

kernel-doc: Fix parsing of DECLARE_BITMAP in struct 



Some documented structures in the kernel use DECLARE_BITMAP to create
arrays of unsigned longs to store information using the bitmap functions.
These have to be replaced with a parsable version for kernel-doc.

For example a simple input like

    /**
     * struct something - some test
     * @members: active members
     */
    struct something {
    	DECLARE_BITMAP(members, MAX_MEMBERS);
    };

resulted in parsing warnings like

    warning: No description found for parameter 'MAX_MEMBERS)'
    warning: Excess struct/union/enum/typedef member 'members' description in 'something'

Signed-off-by: default avatarConchúr Navid <conchur@web.de>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 4468e21e

scripts/kernel-doc

+2 −0
Original line number Diff line number Diff line
@@ -1816,6 +1816,8 @@ sub dump_struct($$) { 
	$members =~ s/__attribute__\s*\(\([a-z,_\*\s\(\)]*\)\)//i;

	$members =~ s/__aligned\s*\([^;]*\)//gos;

	$members =~ s/\s*CRYPTO_MINALIGN_ATTR//gos;

	# replace DECLARE_BITMAP

	$members =~ s/DECLARE_BITMAP\s*\(([^,)]+), ([^,)]+)\)/unsigned long $1\[BITS_TO_LONGS($2)\]/gos;



	create_parameterlist($members, ';', $file);

	check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);