From: Simon Horman <horms@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Johannes Berg <johannes@sipsolutions.net>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
linux-wireless@vger.kernel.org, netdev@vger.kernel.org
Subject: Re: [PATCH net] wifi: mac80211: address some kerneldoc warnings
Date: Thu, 21 Dec 2023 18:23:19 +0100 [thread overview]
Message-ID: <20231221172319.GD1056991@kernel.org> (raw)
In-Reply-To: <87zfy4bhxo.fsf@meer.lwn.net>
On Wed, Dec 20, 2023 at 03:57:55PM -0700, Jonathan Corbet wrote:
> include/net/mac80111.h contains a number of either excess or incorrect
> kerneldoc entries for structure members, leading to these warnings:
>
> ./include/net/mac80211.h:491: warning: Excess struct member 'rssi' description in 'ieee80211_event'
> ./include/net/mac80211.h:491: warning: Excess struct member 'mlme' description in 'ieee80211_event'
> ./include/net/mac80211.h:491: warning: Excess struct member 'ba' description in 'ieee80211_event'
> ./include/net/mac80211.h:777: warning: Excess struct member 'ack_enabled' description in 'ieee80211_bss_conf'
> ./include/net/mac80211.h:1222: warning: Excess struct member 'ampdu_ack_len' description in 'ieee80211_tx_info'
> ./include/net/mac80211.h:1222: warning: Excess struct member 'ampdu_len' description in 'ieee80211_tx_info'
> ./include/net/mac80211.h:1222: warning: Excess struct member 'ack_signal' description in 'ieee80211_tx_info'
> ./include/net/mac80211.h:2920: warning: Excess struct member 'radiotap_he' description in 'ieee80211_hw'
>
> Fix or remove the entries as needed. This change removes 208 warnings from
> a "make htmldocs" build.
>
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Thanks Jonathan,
I verified that the above mentioned warnings are present in
next-20231221 without this patch, but not with this patch.
Reviewed-by: Simon Horman <horms@kernel.org>
prev parent reply other threads:[~2023-12-21 17:23 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-20 22:57 [PATCH net] wifi: mac80211: address some kerneldoc warnings Jonathan Corbet
2023-12-21 17:23 ` Simon Horman [this message]
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=20231221172319.GD1056991@kernel.org \
--to=horms@kernel.org \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=johannes@sipsolutions.net \
--cc=kuba@kernel.org \
--cc=linux-wireless@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
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;
as well as URLs for NNTP newsgroup(s).