Received-SPF: pass (google.com: domain of linux-wireless+bounces-1172-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
Date: Thu, 21 Dec 2023 18:23:19 +0100
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
Message-ID: <20231221172319.GD1056991@kernel.org>
References: <87zfy4bhxo.fsf@meer.lwn.net>
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
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>