From: Simon Horman <horms@kernel•org>
To: Randy Dunlap <rdunlap@infradead•org>
Cc: netdev@vger•kernel.org, Alexander Aring <alex.aring@gmail•com>,
Stefan Schmidt <stefan@datenfreihafen•org>,
Miquel Raynal <miquel.raynal@bootlin•com>,
linux-wpan@vger•kernel.org,
"David S. Miller" <davem@davemloft•net>,
Eric Dumazet <edumazet@google•com>,
Jakub Kicinski <kuba@kernel•org>, Paolo Abeni <pabeni@redhat•com>
Subject: Re: [PATCH] nl802154: fix some kernel-doc warnings
Date: Thu, 16 Oct 2025 13:53:52 +0100 [thread overview]
Message-ID: <aPDq4BJnxji5mTxc@horms.kernel.org> (raw)
In-Reply-To: <20251016035917.1148012-1-rdunlap@infradead.org>
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@infradead•org>
Reviewed-by: Simon Horman <horms@kernel•org>
next prev parent reply other threads:[~2025-10-16 12:53 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-10-16 3:59 [PATCH] nl802154: fix some kernel-doc warnings Randy Dunlap
2025-10-16 12:53 ` Simon Horman [this message]
2025-10-21 0:20 ` patchwork-bot+netdevbpf
2025-10-22 9:24 ` Miquel Raynal
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=aPDq4BJnxji5mTxc@horms.kernel.org \
--to=horms@kernel$(echo .)org \
--cc=alex.aring@gmail$(echo .)com \
--cc=davem@davemloft$(echo .)net \
--cc=edumazet@google$(echo .)com \
--cc=kuba@kernel$(echo .)org \
--cc=linux-wpan@vger$(echo .)kernel.org \
--cc=miquel.raynal@bootlin$(echo .)com \
--cc=netdev@vger$(echo .)kernel.org \
--cc=pabeni@redhat$(echo .)com \
--cc=rdunlap@infradead$(echo .)org \
--cc=stefan@datenfreihafen$(echo .)org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox