]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
docs: kdoc_parser: don't mangle with function defines
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Mon, 2 Mar 2026 16:40:47 +0000 (17:40 +0100)
committerJonathan Corbet <corbet@lwn.net>
Tue, 3 Mar 2026 17:47:24 +0000 (10:47 -0700)
commitcca1bbdd72f72a3cf86d90fd6f326fd709ae931f
treea35cdf9212bde155b1abb7d00cdc93363bdcec82
parent77e6e17e9fc4cb4e59ad97de5453bb6f963a5fd4
docs: kdoc_parser: don't mangle with function defines

Mangling with #defines is not nice, as we may end removing
the macro names, preventing several macros from being properly
documented.

Also, on defines, we have something like:

#define foo(a1, a2, a3, ...)  \
/* some real implementation */

The prototype part (first line on this example) won't contain
any macros, so no need to apply any regexes on it.

With that, move the apply_transforms() logic to ensure that
it will be called only on functions.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <8f9854c8ca1c794b6a3fe418f7adbc32aa68b432.1772469446.git.mchehab+huawei@kernel.org>
tools/lib/python/kdoc/kdoc_parser.py