Commit 18182f97 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jonathan Corbet
Browse files

docs: kdoc_parser: use '@' for Excess enum value 



kdoc is looking for "@value" here, so use that kind of string in the
warning message. The "%value" can be confusing.

This changes:
Warning: drivers/net/wireless/mediatek/mt76/testmode.h:92 Excess enum value '%MT76_TM_ATTR_TX_PENDING' description in 'mt76_testmode_attr'

to this:
Warning: drivers/net/wireless/mediatek/mt76/testmode.h:92 Excess enum value '@MT76_TM_ATTR_TX_PENDING' description in 'mt76_testmode_attr'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Reviewed-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Message-ID: <20251126061752.3497106-1-rdunlap@infradead.org>
parent e36a7b1e

tools/lib/python/kdoc/kdoc_parser.py

+1 −1
Original line number Diff line number Diff line
@@ -922,7 +922,7 @@ class KernelDoc: 
        for k in self.entry.parameterdescs:

            if k not in member_set:

                self.emit_msg(ln,

                              f"Excess enum value '%{k}' description in '{declaration_name}'")

                              f"Excess enum value '@{k}' description in '{declaration_name}'")



        self.output_declaration('enum', declaration_name,

                                purpose=self.entry.declaration_purpose)