bybrooklyn/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-04-18 06:44:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: net: bridge: document stp_mode attribute

Browse Source 
Add documentation for the IFLA_BR_STP_MODE bridge attribute in the
"User space STP helper" section of the bridge documentation. Reference
the BR_STP_MODE_* values via kernel-doc and describe the use case for
network namespace environments.

Reviewed-by: Ido Schimmel <idosch@nvidia.com>
Acked-by: Nikolay Aleksandrov <nikolay@nvidia.com>
Signed-off-by: Andy Roulin <aroulin@nvidia.com>
Link: https://patch.msgid.link/20260405205224.3163000-3-aroulin@nvidia.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
Andy Roulin
2026-04-05 13:52:23 -07:00
committed by Jakub Kicinski
parent 54fc83a172
commit c4f2aab121
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Documentation/networking/bridge.rst
View File

@@ -148,6 +148,28 @@ called by the kernel when STP is enabled/disabled on a bridge
stp_state <0|1>``). The kernel enables user_stp mode if that command returns
0, or enables kernel_stp mode if that command returns any other value.
STP mode selection
------------------
The ``IFLA_BR_STP_MODE`` bridge attribute allows explicit control over how
STP operates when enabled, bypassing the ``/sbin/bridge-stp`` helper
entirely for the ``user`` and ``kernel`` modes.
.. kernel-doc:: include/uapi/linux/if_link.h
:doc: Bridge STP mode values
The default mode is ``BR_STP_MODE_AUTO``, which preserves the traditional
behavior of invoking the ``/sbin/bridge-stp`` helper. The ``user`` and
``kernel`` modes are particularly useful in network namespace environments
where the helper mechanism is not available, as ``call_usermodehelper()``
is restricted to the initial network namespace.
Example::
ip link set dev br0 type bridge stp_mode user stp_state 1
The mode can only be changed while STP is disabled.
VLAN
====