diff options
| author |  Hangbin Liu <liuhangbin@gmail.com>
| 2023-12-01 16:19:44 +0800 |
|---|---|---|
| committer |  Paolo Abeni <pabeni@redhat.com>
| 2023-12-05 10:48:00 +0100 |
| commit | bcc1f84e4d3480636d8ff7458bfdda9ff908a3d7 (patch) | |
| tree | 4ac0808e18f82aa57cbe8c252b31c677c0ad2cda /Documentation/networking | |
| parent | net: bridge: add document for IFLA_BRPORT enum (diff) | |
| download | linux-bcc1f84e4d3480636d8ff7458bfdda9ff908a3d7.tar.gz linux-bcc1f84e4d3480636d8ff7458bfdda9ff908a3d7.tar.bz2 linux-bcc1f84e4d3480636d8ff7458bfdda9ff908a3d7.zip | |
docs: bridge: Add kAPI/uAPI fields
Add kAPI/uAPI field for bridge doc. Update struct net_bridge_vlan
comments to fix doc build warning.
Reviewed-by: Florian Fainelli <florian.fainelli@broadcom.com>
Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
Acked-by: Nikolay Aleksandrov <razor@blackwall.org>
Signed-off-by: Paolo Abeni <pabeni@redhat.com>
Diffstat (limited to 'Documentation/networking')
| -rw-r--r-- | Documentation/networking/bridge.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/Documentation/networking/bridge.rst b/Documentation/networking/bridge.rst index 6ad8b42b2c50..a717563eaa15 100644 --- a/Documentation/networking/bridge.rst +++ b/Documentation/networking/bridge.rst @@ -14,6 +14,39 @@ at the data link layer (Layer 2) of the OSI (Open Systems Interconnection) model. The purpose of a bridge is to filter and forward frames between different segments based on the destination MAC (Media Access Control) address. +Bridge kAPI +=========== + +Here are some core structures of bridge code. Note that the kAPI is *unstable*, +and can be changed at any time. + +.. kernel-doc:: net/bridge/br_private.h + :identifiers: net_bridge_vlan + +Bridge uAPI +=========== + +Modern Linux bridge uAPI is accessed via Netlink interface. You can find +below files where the bridge and bridge port netlink attributes are defined. + +Bridge netlink attributes +------------------------- + +.. kernel-doc:: include/uapi/linux/if_link.h + :doc: Bridge enum definition + +Bridge port netlink attributes +------------------------------ + +.. kernel-doc:: include/uapi/linux/if_link.h + :doc: Bridge port enum definition + +Bridge sysfs +------------ + +The sysfs interface is deprecated and should not be extended if new +options are added. + FAQ === |