From: Kalle Valo <kvalo@kernel.org>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
Johannes Berg <johannes@sipsolutions.net>,
linux-wireless@vger.kernel.org, netdev@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] wifi: cfg80211: address several kerneldoc warnings
Date: Wed, 20 Dec 2023 09:20:22 +0200 [thread overview]
Message-ID: <87a5q5qr0p.fsf@kernel.org> (raw)
In-Reply-To: <124652c4-081a-42a4-9f58-e5f156f08e90@infradead.org> (Randy Dunlap's message of "Tue, 19 Dec 2023 22:51:21 -0800")
Randy Dunlap <rdunlap@infradead.org> writes:
> On 12/19/23 22:35, Kalle Valo wrote:
>> Jonathan Corbet <corbet@lwn.net> writes:
>>
>>> include/net/cfg80211.h includes a number of kerneldoc entries for struct
>>> members that do not exist, leading to these warnings:
>>>
>>> ./include/net/cfg80211.h:3192: warning: Excess struct member
>>> 'band_pref' description in 'cfg80211_bss_selection'
>>> ./include/net/cfg80211.h:3192: warning: Excess struct member
>>> 'adjust' description in 'cfg80211_bss_selection'
>>> ./include/net/cfg80211.h:6181: warning: Excess struct member
>>> 'bssid' description in 'wireless_dev'
>>> ./include/net/cfg80211.h:6181: warning: Excess struct member
>>> 'beacon_interval' description in 'wireless_dev'
>>> ./include/net/cfg80211.h:7299: warning: Excess struct member
>>> 'bss' description in 'cfg80211_rx_assoc_resp_data'
>>>
>>> Remove and/or repair each entry to address the warnings and ensure a proper
>>> docs build for the affected structures.
>>>
>>> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
>>
>> I try to periodically check for kerneldoc warnings in wireless trees but
>> I have never seen these. Am I missing something or did you do something
>> special (enable new warnings etc.)?
>
> There are new patches from both Kees Cook and me to report Excess kernel-doc
> descriptions, so now there are a bunch of kernel-doc warnings that we are working
> to fix quickly. :(
Got it, thanks. Good to know that I wasn't missing anything.
--
https://patchwork.kernel.org/project/linux-wireless/list/
https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
prev parent reply other threads:[~2023-12-20 7:20 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-20 0:01 [PATCH] wifi: cfg80211: address several kerneldoc warnings Jonathan Corbet
2023-12-20 1:00 ` Jeff Johnson
2023-12-20 2:29 ` Randy Dunlap
2023-12-20 2:28 ` Randy Dunlap
2023-12-20 6:35 ` Kalle Valo
2023-12-20 6:51 ` Randy Dunlap
2023-12-20 7:20 ` Kalle Valo [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=87a5q5qr0p.fsf@kernel.org \
--to=kvalo@kernel.org \
--cc=corbet@lwn.net \
--cc=johannes@sipsolutions.net \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-wireless@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=rdunlap@infradead.org \
/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).