netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct
@ 2025-12-18  4:29 Bagas Sanjaya
  2025-12-18 10:47 ` Nikolay Aleksandrov
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2025-12-18  4:29 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Networking, bridge
  Cc: Nikolay Aleksandrov, Ido Schimmel, David S. Miller, Eric Dumazet,
	Jakub Kicinski, Paolo Abeni, Simon Horman, Roopa Prabhu,
	Bagas Sanjaya

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


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct
  2025-12-18  4:29 [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct Bagas Sanjaya
@ 2025-12-18 10:47 ` Nikolay Aleksandrov
  2025-12-18 12:10 ` Ido Schimmel
  2025-12-28  9:31 ` patchwork-bot+netdevbpf
  2 siblings, 0 replies; 4+ messages in thread
From: Nikolay Aleksandrov @ 2025-12-18 10:47 UTC (permalink / raw)
  To: Bagas Sanjaya, Linux Kernel Mailing List, Linux Networking,
	bridge
  Cc: Ido Schimmel, David S. Miller, Eric Dumazet, Jakub Kicinski,
	Paolo Abeni, Simon Horman, Roopa Prabhu

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>

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct
  2025-12-18  4:29 [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct Bagas Sanjaya
  2025-12-18 10:47 ` Nikolay Aleksandrov
@ 2025-12-18 12:10 ` Ido Schimmel
  2025-12-28  9:31 ` patchwork-bot+netdevbpf
  2 siblings, 0 replies; 4+ messages in thread
From: Ido Schimmel @ 2025-12-18 12:10 UTC (permalink / raw)
  To: Bagas Sanjaya
  Cc: Linux Kernel Mailing List, Linux Networking, bridge,
	Nikolay Aleksandrov, David S. Miller, Eric Dumazet,
	Jakub Kicinski, Paolo Abeni, Simon Horman, Roopa Prabhu

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct
  2025-12-18  4:29 [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct Bagas Sanjaya
  2025-12-18 10:47 ` Nikolay Aleksandrov
  2025-12-18 12:10 ` Ido Schimmel
@ 2025-12-28  9:31 ` patchwork-bot+netdevbpf
  2 siblings, 0 replies; 4+ messages in thread
From: patchwork-bot+netdevbpf @ 2025-12-28  9:31 UTC (permalink / raw)
  To: Bagas Sanjaya
  Cc: linux-kernel, netdev, bridge, razor, idosch, davem, edumazet,
	kuba, pabeni, horms, roopa

Hello:

This patch was applied to netdev/net.git (main)
by Paolo Abeni <pabeni@redhat.com>:

On Thu, 18 Dec 2025 11:29:37 +0700 you 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>
> 
> [...]

Here is the summary with links:
  - [net,v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct
    https://git.kernel.org/netdev/net/c/f79f9b7ace17

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2025-12-28  9:34 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-12-18  4:29 [PATCH net v2] net: bridge: Describe @tunnel_hash member in net_bridge_vlan_group struct Bagas Sanjaya
2025-12-18 10:47 ` Nikolay Aleksandrov
2025-12-18 12:10 ` Ido Schimmel
2025-12-28  9:31 ` patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).