linux-kernel - Re: [PATCH] wifi: mac80222: Fix ieee80211

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: <a009a21a-56d7-4a1a-aaf9-feefa5acc561@infradead.org>
Date: Thu, 28 Mar 2024 15:16:07 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Jeff Johnson <quic_jjohnson@...cinc.com>,
 Johannes Berg <johannes@...solutions.net>,
 "David S. Miller" <davem@...emloft.net>, Eric Dumazet <edumazet@...gle.com>,
 Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>
Cc: linux-wireless@...r.kernel.org, netdev@...r.kernel.org,
 linux-kernel@...r.kernel.org
Subject: Re: [PATCH] wifi: mac80222: Fix ieee80211_i.h kernel-doc issues

Hi,

On 3/28/24 14:08, Jeff Johnson wrote:
> kernel-doc flagged the following issues:
> 
> net/mac80211/ieee80211_i.h:146: warning: expecting prototype for enum ieee80211_corrupt_data_flags. Prototype was for enum ieee80211_bss_corrupt_data_flags instead
> net/mac80211/ieee80211_i.h:163: warning: expecting prototype for enum ieee80211_valid_data_flags. Prototype was for enum ieee80211_bss_valid_data_flags instead
> 
> Correct the documentation to match the code.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@...cinc.com>

These seem to be corrected in linux-next already.
However, I do still see this one:

ieee80211_i.h:689: warning: missing initial short description on line:
 * struct mesh_table

Thanks.

> ---
> This file is being modified by a quicinc.com patch and my review
> process flagged these pre-existing kernel-doc issues.
> ---
>  net/mac80211/ieee80211_i.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/net/mac80211/ieee80211_i.h b/net/mac80211/ieee80211_i.h
> index def611e4e55f..458f63ce9a32 100644
> --- a/net/mac80211/ieee80211_i.h
> +++ b/net/mac80211/ieee80211_i.h
> @@ -132,7 +132,7 @@ struct ieee80211_bss {
>  };
>  
>  /**
> - * enum ieee80211_corrupt_data_flags - BSS data corruption flags
> + * enum ieee80211_bss_corrupt_data_flags - BSS data corruption flags
>   * @IEEE80211_BSS_CORRUPT_BEACON: last beacon frame received was corrupted
>   * @IEEE80211_BSS_CORRUPT_PROBE_RESP: last probe response received was corrupted
>   *
> @@ -145,7 +145,7 @@ enum ieee80211_bss_corrupt_data_flags {
>  };
>  
>  /**
> - * enum ieee80211_valid_data_flags - BSS valid data flags
> + * enum ieee80211_bss_valid_data_flags - BSS valid data flags
>   * @IEEE80211_BSS_VALID_WMM: WMM/UAPSD data was gathered from non-corrupt IE
>   * @IEEE80211_BSS_VALID_RATES: Supported rates were gathered from non-corrupt IE
>   * @IEEE80211_BSS_VALID_ERP: ERP flag was gathered from non-corrupt IE
> 
> ---
> base-commit: b68b2beadfd30907faae944358de3a17acf6fdb6
> change-id: 20240328-ieee80211_i-kerneldoc-d28d95f5c5d3
> 
> 

-- 
#Randy