Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: 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>

authored by

Randy Dunlap and committed by
Jonathan Corbet
18182f97 e36a7b1e

+1 -1
+1 -1
tools/lib/python/kdoc/kdoc_parser.py
··· 922 922 for k in self.entry.parameterdescs: 923 923 if k not in member_set: 924 924 self.emit_msg(ln, 925 - f"Excess enum value '%{k}' description in '{declaration_name}'") 925 + f"Excess enum value '@{k}' description in '{declaration_name}'") 926 926 927 927 self.output_declaration('enum', declaration_name, 928 928 purpose=self.entry.declaration_purpose)