linux-kernel - Re: [PATCH] wifi: cfg80211: address several kerneldoc 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] [thread-next>] [day] [month] [year] [list]

Message-ID: <124652c4-081a-42a4-9f58-e5f156f08e90@infradead.org>
Date: Tue, 19 Dec 2023 22:51:21 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Kalle Valo <kvalo@...nel.org>, Jonathan Corbet <corbet@....net>
Cc: Johannes Berg <johannes@...solutions.net>,
 linux-wireless@...r.kernel.org, netdev@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH] wifi: cfg80211: address several kerneldoc warnings



On 12/19/23 22:35, Kalle Valo wrote:
> Jonathan Corbet <corbet@....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@....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.  :(

-- 
#Randy
https://people.kernel.org/tglx/notes-about-netiquette
https://subspace.kernel.org/etiquette.html