2024-03-29 05:44:48

by Jeff Johnson

Subject: [PATCH] wifi: mac80211: correctly document struct mesh_table

Currently kernel-doc -Wall reports:

net/mac80211/ieee80211_i.h:687: warning: missing initial short description on line:
* struct mesh_table

So add a short description.

Reported-by: Randy Dunlap <[email protected]>
Link: https://lore.kernel.org/linux-wireless/[email protected]/
Signed-off-by: Jeff Johnson <[email protected]>
---
net/mac80211/ieee80211_i.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/net/mac80211/ieee80211_i.h b/net/mac80211/ieee80211_i.h
index bd507d6b65e3..3b3eb3162441 100644
--- a/net/mac80211/ieee80211_i.h
+++ b/net/mac80211/ieee80211_i.h
@@ -684,7 +684,7 @@ struct mesh_csa_settings {
};

/**
- * struct mesh_table
+ * struct mesh_table - mesh hash table
*
* @known_gates: list of known mesh gates and their mpaths by the station. The
* gate's mpath may or may not be resolved and active.

---
base-commit: 8ea3f4f1a1b4242d5fc273f41aa7c86f6b40178c
change-id: 20240328-mesh_table-kerneldoc-6b1e0a9e8344

2024-03-29 05:49:41

by Randy Dunlap

Subject: Re: [PATCH] wifi: mac80211: correctly document struct mesh_table

On 3/28/24 22:44, Jeff Johnson wrote:
> Currently kernel-doc -Wall reports:
>
> net/mac80211/ieee80211_i.h:687: warning: missing initial short description on line:
> * struct mesh_table
>
> So add a short description.
>
> Reported-by: Randy Dunlap <[email protected]>
> Link: https://lore.kernel.org/linux-wireless/[email protected]/
> Signed-off-by: Jeff Johnson <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> net/mac80211/ieee80211_i.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/net/mac80211/ieee80211_i.h b/net/mac80211/ieee80211_i.h
> index bd507d6b65e3..3b3eb3162441 100644
> --- a/net/mac80211/ieee80211_i.h
> +++ b/net/mac80211/ieee80211_i.h
> @@ -684,7 +684,7 @@ struct mesh_csa_settings {
> };
>
> /**
> - * struct mesh_table
> + * struct mesh_table - mesh hash table
> *
> * @known_gates: list of known mesh gates and their mpaths by the station. The
> * gate's mpath may or may not be resolved and active.
>
> ---
> base-commit: 8ea3f4f1a1b4242d5fc273f41aa7c86f6b40178c
> change-id: 20240328-mesh_table-kerneldoc-6b1e0a9e8344
>

--
#Randy