2024-03-28 22:22:19

by Randy Dunlap

[permalink] [raw]
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 <[email protected]>

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