net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct

[PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct

Posted by Bagas Sanjaya 1 month, 3 weeks ago

Sphinx reports kernel-doc warning:

WARNING: ./net/bridge/br_private.h:267 struct member 'tunnel_hash' not described in 'net_bridge_vlan_group'

Fix it by describing @tunnel_hash member.

Fixes: efa5356b0d9753 ("bridge: per vlan dst_metadata netlink support")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
This patch is split from assorted kernel-doc fixes series [1].

Changes since v1 [2]:

  - Apply wording suggestion (Ido)

[1]: https://lore.kernel.org/netdev/20251215113903.46555-1-bagasdotme@gmail.com/
[2]: https://lore.kernel.org/netdev/20251215113903.46555-15-bagasdotme@gmail.com/

 net/bridge/br_private.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/net/bridge/br_private.h b/net/bridge/br_private.h
index 7280c4e9305f36..b9b2981c484149 100644
--- a/net/bridge/br_private.h
+++ b/net/bridge/br_private.h
@@ -247,6 +247,7 @@ struct net_bridge_vlan {
  * struct net_bridge_vlan_group
  *
  * @vlan_hash: VLAN entry rhashtable
+ * @tunnel_hash: Hash table to map from tunnel key ID (e.g. VXLAN VNI) to VLAN
  * @vlan_list: sorted VLAN entry list
  * @num_vlans: number of total VLAN entries
  * @pvid: PVID VLAN id

base-commit: 885bebac9909994050bbbeed0829c727e42bd1b7
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct

Posted by Ido Schimmel 1 month, 3 weeks ago

On Thu, Dec 18, 2025 at 11:29:37AM +0700, Bagas Sanjaya wrote:
> Sphinx reports kernel-doc warning:
> 
> WARNING: ./net/bridge/br_private.h:267 struct member 'tunnel_hash' not described in 'net_bridge_vlan_group'
> 
> Fix it by describing @tunnel_hash member.
> 
> Fixes: efa5356b0d9753 ("bridge: per vlan dst_metadata netlink support")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Ido Schimmel <idosch@nvidia.com>

Thanks

Re: [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct

Posted by Nikolay Aleksandrov 1 month, 3 weeks ago

On 18/12/2025 06:29, Bagas Sanjaya wrote:
> Sphinx reports kernel-doc warning:
> 
> WARNING: ./net/bridge/br_private.h:267 struct member 'tunnel_hash' not described in 'net_bridge_vlan_group'
> 
> Fix it by describing @tunnel_hash member.
> 
> Fixes: efa5356b0d9753 ("bridge: per vlan dst_metadata netlink support")
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> This patch is split from assorted kernel-doc fixes series [1].
> 
> Changes since v1 [2]:
> 
>    - Apply wording suggestion (Ido)
> 
> [1]: https://lore.kernel.org/netdev/20251215113903.46555-1-bagasdotme@gmail.com/
> [2]: https://lore.kernel.org/netdev/20251215113903.46555-15-bagasdotme@gmail.com/
> 
>   net/bridge/br_private.h | 1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/net/bridge/br_private.h b/net/bridge/br_private.h
> index 7280c4e9305f36..b9b2981c484149 100644
> --- a/net/bridge/br_private.h
> +++ b/net/bridge/br_private.h
> @@ -247,6 +247,7 @@ struct net_bridge_vlan {
>    * struct net_bridge_vlan_group
>    *
>    * @vlan_hash: VLAN entry rhashtable
> + * @tunnel_hash: Hash table to map from tunnel key ID (e.g. VXLAN VNI) to VLAN
>    * @vlan_list: sorted VLAN entry list
>    * @num_vlans: number of total VLAN entries
>    * @pvid: PVID VLAN id
> 
> base-commit: 885bebac9909994050bbbeed0829c727e42bd1b7

Acked-by: Nikolay Aleksandrov <razor@blackwall.org>