netdev - Re: [PATCH] nl802154: fix some kernel-doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <aPDq4BJnxji5mTxc@horms.kernel.org>
Date: Thu, 16 Oct 2025 13:53:52 +0100
From: Simon Horman <horms@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: netdev@...r.kernel.org, Alexander Aring <alex.aring@...il.com>,
	Stefan Schmidt <stefan@...enfreihafen.org>,
	Miquel Raynal <miquel.raynal@...tlin.com>,
	linux-wpan@...r.kernel.org, "David S. Miller" <davem@...emloft.net>,
	Eric Dumazet <edumazet@...gle.com>,
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>
Subject: Re: [PATCH] nl802154: fix some kernel-doc warnings

Thanks Randy,

On Wed, Oct 15, 2025 at 08:59:17PM -0700, Randy Dunlap wrote:
> Correct multiple kernel-doc warnings in nl802154.h:
> 
> - Fix a typo on one enum name to avoid a kernel-doc warning.
> - Drop 2 enum descriptions that are no longer needed.

According to my brief dig into git history,
it seems those were added but never used.

> - Mark 2 internal enums as "private:" so that kernel-doc is not needed
>   for them.
> 
> Warning: nl802154.h:239 Enum value 'NL802154_CAP_ATTR_MAX_MAXBE' not described in enum 'nl802154_wpan_phy_capability_attr'
> Warning: nl802154.h:239 Excess enum value '%NL802154_CAP_ATTR_MIN_CCA_ED_LEVEL' description in 'nl802154_wpan_phy_capability_attr'
> Warning: nl802154.h:239 Excess enum value '%NL802154_CAP_ATTR_MAX_CCA_ED_LEVEL' description in 'nl802154_wpan_phy_capability_attr'
> Warning: nl802154.h:369 Enum value '__NL802154_CCA_OPT_ATTR_AFTER_LAST' not described in enum 'nl802154_cca_opts'
> Warning: nl802154.h:369 Enum value 'NL802154_CCA_OPT_ATTR_MAX' not described in enum 'nl802154_cca_opts'

I do still see:
Warning: include/net/nl802154.h:237 Enum value 'NL802154_CAP_ATTR_CCA_ED_LEVELS' not described in enum 'nl802154_wpan_phy_capability_attr'

And that enum does seem to be used. So it would be nice to address this
by documenting it. But I think that can be left as a separate task.

> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>

Reviewed-by: Simon Horman <horms@...nel.org>