]> Gentwo Git Trees - linux/.git/commitdiff
docs: kdoc_parser: use '@' for Excess enum value
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 26 Nov 2025 06:17:52 +0000 (22:17 -0800)
committerJonathan Corbet <corbet@lwn.net>
Sat, 29 Nov 2025 15:31:17 +0000 (08:31 -0700)
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: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251126061752.3497106-1-rdunlap@infradead.org>

tools/lib/python/kdoc/kdoc_parser.py

index c14bb382b810ff69306292e2507aaafb7d8cd37a..a32682bc050bc4f586df268da6ac3fb16ec7da4a 100644 (file)
@@ -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)