| Message ID | 20240328-mesh_table-kerneldoc-v1-1-174c4df341b1@quicinc.com (mailing list archive) |
|---|---|
| State | Accepted |
| Delegated to: | Johannes Berg |
| Headers | show |
| Series | wifi: mac80211: correctly document struct mesh_table | expand |
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 <rdunlap@infradead.org> > Link: https://lore.kernel.org/linux-wireless/a009a21a-56d7-4a1a-aaf9-feefa5acc561@infradead.org/ > Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> 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 >
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.
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 <rdunlap@infradead.org> Link: https://lore.kernel.org/linux-wireless/a009a21a-56d7-4a1a-aaf9-feefa5acc561@infradead.org/ Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com> --- net/mac80211/ieee80211_i.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) --- base-commit: 8ea3f4f1a1b4242d5fc273f41aa7c86f6b40178c change-id: 20240328-mesh_table-kerneldoc-6b1e0a9e8344