]> www.infradead.org Git - users/dwmw2/linux.git/commit
tools: ynl-gen: de-kdocify enums with no doc for entries
authorJakub Kicinski <kuba@kernel.org>
Sun, 3 Nov 2024 16:53:14 +0000 (08:53 -0800)
committerJakub Kicinski <kuba@kernel.org>
Tue, 5 Nov 2024 02:11:47 +0000 (18:11 -0800)
commit690e50dd69ee48e43e0f7c42396487da1b81be14
treeb67faff7d3b6a9d13837ce286b22adb34a4129e6
parent0a2cdeeae9ddc14d752173be6af98bc9fb45c6ad
tools: ynl-gen: de-kdocify enums with no doc for entries

Sometimes the names of the enum entries are self-explanatory
or come from standards. Forcing authors to write trivial kdoc
for each of such entries seems unreasonable, but kdoc would
complain about undocumented entries.

Detect enums which only have documentation for the entire
type and no documentation for entries. Render their doc
as a plain comment.

Link: https://patch.msgid.link/20241103165314.1631237-1-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
include/uapi/linux/dpll.h
tools/net/ynl/lib/nlspec.py
tools/net/ynl/ynl-gen-c.py