| Message ID | 20231128084943.637091-2-liuhangbin@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | Doc: update bridge doc | expand |
On Tue, 28 Nov 2023 16:49:34 +0800 Hangbin Liu <liuhangbin@gmail.com> wrote: > The current bridge kernel doc is too old. It only pointed to the > linuxfoundation wiki page which lacks of the new features. > > Here let's start the new bridge document and put all the bridge info > so new developers and users could catch up the last bridge status soon. > > In this patch, Convert the doc to rst format. Add bridge brief introduction, > FAQ and contact info. > > Signed-off-by: Hangbin Liu <liuhangbin@gmail.com> Should also reference and borrow definitions from the IEEE 802.1D standard.
On 11/28/2023 12:49 AM, Hangbin Liu wrote: > The current bridge kernel doc is too old. It only pointed to the > linuxfoundation wiki page which lacks of the new features. > > Here let's start the new bridge document and put all the bridge info > so new developers and users could catch up the last bridge status soon. > > In this patch, Convert the doc to rst format. Add bridge brief introduction, > FAQ and contact info. > > Signed-off-by: Hangbin Liu <liuhangbin@gmail.com> Reviewed-by: Florian Fainelli <florian.fainelli@broadcom.com>
On Tue, Nov 28, 2023 at 02:46:09PM -0800, Stephen Hemminger wrote: > On Tue, 28 Nov 2023 16:49:34 +0800 > Hangbin Liu <liuhangbin@gmail.com> wrote: > > > The current bridge kernel doc is too old. It only pointed to the > > linuxfoundation wiki page which lacks of the new features. > > > > Here let's start the new bridge document and put all the bridge info > > so new developers and users could catch up the last bridge status soon. > > > > In this patch, Convert the doc to rst format. Add bridge brief introduction, > > FAQ and contact info. > > > > Signed-off-by: Hangbin Liu <liuhangbin@gmail.com> > > Should also reference and borrow definitions from the IEEE 802.1D standard. Hi Stephen, Do you mean to use the definitions from the IEEE 802.1D in the doc? Something like: The IEEE 802.1D standard defines the operation of bridges in computer networks. A bridge, in the context of this standard, is a device that connects two or more network segments and operates 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. Thanks Hangbin
diff --git a/Documentation/networking/bridge.rst b/Documentation/networking/bridge.rst index c859f3c1636e..de112e92a305 100644 --- a/Documentation/networking/bridge.rst +++ b/Documentation/networking/bridge.rst @@ -4,18 +4,43 @@ Ethernet Bridging ================= -In order to use the Ethernet bridging functionality, you'll need the -userspace tools. +Introduction +============ -Documentation for Linux bridging is on: - https://wiki.linuxfoundation.org/networking/bridge +A bridge is a way to connect multiple Ethernet segments together in a protocol +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. -The bridge-utilities are maintained at: - git://git.kernel.org/pub/scm/linux/kernel/git/shemminger/bridge-utils.git +FAQ +=== -Additionally, the iproute2 utilities can be used to configure -bridge devices. +What does a bridge do? +---------------------- -If you still have questions, don't hesitate to post to the mailing list -(more info https://lists.linux-foundation.org/mailman/listinfo/bridge). +A bridge transparently forwards traffic between multiple network interfaces. +In plain English this means that a bridge connects two or more physical +Ethernet networks, to form one larger (logical) Ethernet network. +Is it L3 protocol independent? +------------------------------ + +Yes. The bridge sees all frames, but it *uses* only L2 headers/information. +As such, the bridging functionality is protocol independent, and there should +be no trouble forwarding IPX, NetBEUI, IP, IPv6, etc. + +Contact Info +============ + +The code is currently maintained by Roopa Prabhu <roopa@nvidia.com> and +Nikolay Aleksandrov <razor@blackwall.org>. Bridge bugs and enhancements +are discussed on the linux-netdev mailing list netdev@vger.kernel.org and +bridge@lists.linux-foundation.org. + +The list is open to anyone interested: http://vger.kernel.org/vger-lists.html#netdev + +External Links +============== + +The old Documentation for Linux bridging is on: +https://wiki.linuxfoundation.org/networking/bridge
The current bridge kernel doc is too old. It only pointed to the linuxfoundation wiki page which lacks of the new features. Here let's start the new bridge document and put all the bridge info so new developers and users could catch up the last bridge status soon. In this patch, Convert the doc to rst format. Add bridge brief introduction, FAQ and contact info. Signed-off-by: Hangbin Liu <liuhangbin@gmail.com> --- Documentation/networking/bridge.rst | 45 ++++++++++++++++++++++------- 1 file changed, 35 insertions(+), 10 deletions(-)