Re: [PATCH iproute2-next 3/3] man: man8: bridge: Describe mcast_max_groups

From: Nikolay Aleksandrov <razor@blackwall.org>
To: Petr Machata <petrm@nvidia.com>,
	netdev@vger.kernel.org, dsahern@gmail.com,
	stephen@networkplumber.org
Cc: Ido Schimmel <idosch@nvidia.com>
Subject: Re: [PATCH iproute2-next 3/3] man: man8: bridge: Describe mcast_max_groups
Date: Tue, 7 Feb 2023 00:08:56 +0100	[thread overview]
Message-ID: <0b6635f8-1b5a-80ec-8cc8-5b463d963d2c@blackwall.org> (raw)
In-Reply-To: <924ecbb716124faa45ffb204b68b679634839293.1675705077.git.petrm@nvidia.com>

On 2/6/23 19:50, Petr Machata wrote:
> Add documentation for per-port and port-port-vlan option mcast_max_groups.
> 
> Signed-off-by: Petr Machata <petrm@nvidia.com>
> ---
>   man/man8/bridge.8 | 22 ++++++++++++++++++++++
>   1 file changed, 22 insertions(+)
> 
> diff --git a/man/man8/bridge.8 b/man/man8/bridge.8
> index f73e538a3536..7075eab283fa 100644
> --- a/man/man8/bridge.8
> +++ b/man/man8/bridge.8
> @@ -47,6 +47,8 @@ bridge \- show / manipulate bridge addresses and devices
>   .BR hwmode " { " vepa " | " veb " } ] [ "
>   .BR bcast_flood " { " on " | " off " } ] [ "
>   .BR mcast_flood " { " on " | " off " } ] [ "
> +.BR mcast_max_groups
> +.IR MAX_GROUPS " ] ["
>   .BR mcast_router
>   .IR MULTICAST_ROUTER " ] ["
>   .BR mcast_to_unicast " { " on " | " off " } ] [ "
> @@ -169,6 +171,8 @@ bridge \- show / manipulate bridge addresses and devices
>   .IR VID " [ "
>   .B state
>   .IR STP_STATE " ] [ "
> +.B mcast_max_groups
> +.IR MAX_GROUPS " ] [ "
>   .B mcast_router
>   .IR MULTICAST_ROUTER " ]"
>   
> @@ -517,6 +521,15 @@ By default this flag is on.
>   Controls whether multicast traffic for which there is no MDB entry will be
>   flooded towards this given port. By default this flag is on.
>   
> +.TP
> +.BI mcast_max_groups " MAX_GROUPS "
> +Sets the maximum number of MDB entries that can be registered for a given
> +port. Attempts to register more MDB entries at the port than this limit
> +allows will be rejected, whether they are done through netlink (e.g. the
> +\fBbridge\fR tool), or IGMP or MLD membership reports. Setting a limit to 0
> +has the effect of disabling the limit. See also the \fBip link\fR option
> +\fBmcast_hash_max\fR.
> +

I'd add that the default is 0 (no limit), otherwise looks good to me.

>   .TP
>   .BI mcast_router " MULTICAST_ROUTER "
>   This flag is almost the same as the per-VLAN flag, see below, except its
> @@ -1107,6 +1120,15 @@ is used during the STP election process. In this state, the vlan will only proce
>   STP BPDUs.
>   .sp
>   
> +.TP
> +.BI mcast_max_groups " MAX_GROUPS "
> +Sets the maximum number of MDB entries that can be registered for a given
> +VLAN on a given port. A VLAN-specific equivalent of the per-port option of
> +the same name, see above for details.
> +
> +Note that this option is only available when \fBip link\fR option
> +\fBmcast_vlan_snooping\fR is enabled.
> +
>   .TP
>   .BI mcast_router " MULTICAST_ROUTER "
>   configure this vlan and interface's multicast router mode, note that only modes