From: Hangbin Liu <liuhangbin@gmail.com>
To: netdev@vger.kernel.org
Cc: "David S . Miller" <davem@davemloft.net>,
David Ahern <dsahern@kernel.org>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
Ido Schimmel <idosch@idosch.org>,
Nikolay Aleksandrov <razor@blackwall.org>,
Roopa Prabhu <roopa@nvidia.com>,
Stephen Hemminger <stephen@networkplumber.org>,
Florian Westphal <fw@strlen.de>, Andrew Lunn <andrew@lunn.ch>,
Florian Fainelli <f.fainelli@gmail.com>,
Vladimir Oltean <olteanv@gmail.com>,
Jiri Pirko <jiri@resnulli.us>,
Marc Muehlfeld <mmuehlfe@redhat.com>,
Hangbin Liu <liuhangbin@gmail.com>
Subject: [PATCHv3 net-next 04/10] docs: bridge: Add kAPI/uAPI fields
Date: Tue, 28 Nov 2023 16:49:37 +0800 [thread overview]
Message-ID: <20231128084943.637091-5-liuhangbin@gmail.com> (raw)
In-Reply-To: <20231128084943.637091-1-liuhangbin@gmail.com>
Add kAPI/uAPI field for bridge doc. Update struct net_bridge_vlan
comments to fix doc build warning.
Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
---
Documentation/networking/bridge.rst | 26 ++++++++++++++++++++++++++
net/bridge/br_private.h | 2 ++
2 files changed, 28 insertions(+)
diff --git a/Documentation/networking/bridge.rst b/Documentation/networking/bridge.rst
index de112e92a305..5d6d3c0c15c1 100644
--- a/Documentation/networking/bridge.rst
+++ b/Documentation/networking/bridge.rst
@@ -12,6 +12,32 @@ independent way. Packets are forwarded based on Layer 2 destination Ethernet
address, rather than IP address (like a router). Since forwarding is done
at Layer 2, all Layer 3 protocols can pass through a bridge transparently.
+Bridge kAPI
+===========
+
+Here are some core structures of bridge code.
+
+.. 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
+
FAQ
===
diff --git a/net/bridge/br_private.h b/net/bridge/br_private.h
index 6b7f36769d03..051ea81864ac 100644
--- a/net/bridge/br_private.h
+++ b/net/bridge/br_private.h
@@ -186,6 +186,7 @@ enum {
* struct net_bridge_vlan - per-vlan entry
*
* @vnode: rhashtable member
+ * @tnode: rhashtable member
* @vid: VLAN id
* @flags: bridge vlan flags
* @priv_flags: private (in-kernel) bridge vlan flags
@@ -196,6 +197,7 @@ enum {
* @refcnt: if MASTER flag set, this is bumped for each port referencing it
* @brvlan: if MASTER flag unset, this points to the global per-VLAN context
* for this VLAN entry
+ * @tinfo: bridge tunnel info
* @br_mcast_ctx: if MASTER flag set, this is the global vlan multicast context
* @port_mcast_ctx: if MASTER flag unset, this is the per-port/vlan multicast
* context
--
2.41.0
next prev parent reply other threads:[~2023-11-28 8:50 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-28 8:49 [PATCHv3 net-next 00/10] Doc: update bridge doc Hangbin Liu
2023-11-28 8:49 ` [PATCHv3 net-next 01/10] docs: bridge: update doc format to rst Hangbin Liu
2023-11-28 22:46 ` Stephen Hemminger
2023-11-29 7:34 ` Hangbin Liu
2023-11-29 4:16 ` Florian Fainelli
2023-11-28 8:49 ` [PATCHv3 net-next 02/10] net: bridge: add document for IFLA_BR enum Hangbin Liu
2023-11-29 18:37 ` Vladimir Oltean
2023-11-28 8:49 ` [PATCHv3 net-next 03/10] net: bridge: add document for IFLA_BRPORT enum Hangbin Liu
2023-11-28 8:49 ` Hangbin Liu [this message]
2023-11-28 22:47 ` [PATCHv3 net-next 04/10] docs: bridge: Add kAPI/uAPI fields Stephen Hemminger
2023-11-29 4:11 ` Florian Fainelli
2023-11-28 8:49 ` [PATCHv3 net-next 05/10] docs: bridge: add STP doc Hangbin Liu
2023-11-28 22:48 ` Stephen Hemminger
2023-11-29 7:43 ` Hangbin Liu
2023-11-29 15:10 ` Stephen Hemminger
2023-11-29 18:46 ` Vladimir Oltean
2023-11-29 4:21 ` Florian Fainelli
2023-11-29 18:48 ` Vladimir Oltean
2023-11-28 8:49 ` [PATCHv3 net-next 06/10] docs: bridge: add VLAN doc Hangbin Liu
2023-11-29 4:12 ` Florian Fainelli
2023-11-29 18:40 ` Vladimir Oltean
2023-11-28 8:49 ` [PATCHv3 net-next 07/10] docs: bridge: add multicast doc Hangbin Liu
2023-11-29 4:15 ` Florian Fainelli
2023-11-28 8:49 ` [PATCHv3 net-next 08/10] docs: bridge: add switchdev doc Hangbin Liu
2023-11-29 4:16 ` Florian Fainelli
2023-11-28 8:49 ` [PATCHv3 net-next 09/10] docs: bridge: add netfilter doc Hangbin Liu
2023-11-29 4:18 ` Florian Fainelli
2023-11-28 8:49 ` [PATCHv3 net-next 10/10] docs: bridge: add other features Hangbin Liu
2023-11-29 4:09 ` Florian Fainelli
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20231128084943.637091-5-liuhangbin@gmail.com \
--to=liuhangbin@gmail.com \
--cc=andrew@lunn.ch \
--cc=davem@davemloft.net \
--cc=dsahern@kernel.org \
--cc=edumazet@google.com \
--cc=f.fainelli@gmail.com \
--cc=fw@strlen.de \
--cc=idosch@idosch.org \
--cc=jiri@resnulli.us \
--cc=kuba@kernel.org \
--cc=mmuehlfe@redhat.com \
--cc=netdev@vger.kernel.org \
--cc=olteanv@gmail.com \
--cc=pabeni@redhat.com \
--cc=razor@blackwall.org \
--cc=roopa@nvidia.com \
--cc=stephen@networkplumber.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.