| Message ID | 20231110101548.1900519-5-liuhangbin@gmail.com (mailing list archive) |
|---|---|
| State | Superseded |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | Doc: update bridge doc | expand |
On Fri, Nov 10, 2023 at 06:15:41PM +0800, 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. > > First add kAPI/uAPI and FAQ fields. These 2 fileds are only examples and > more APIs need to be added in future. > > Signed-off-by: Hangbin Liu <liuhangbin@gmail.com> > --- > Documentation/networking/bridge.rst | 83 +++++++++++++++++++++++++---- > 1 file changed, 73 insertions(+), 10 deletions(-) > > diff --git a/Documentation/networking/bridge.rst b/Documentation/networking/bridge.rst > index c859f3c1636e..d06c51960f45 100644 > --- a/Documentation/networking/bridge.rst > +++ b/Documentation/networking/bridge.rst > @@ -4,18 +4,81 @@ > 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 > +Bridge kAPI > +=========== > > -Additionally, the iproute2 utilities can be used to configure > -bridge devices. > +Here are some core structures of bridge code. > > -If you still have questions, don't hesitate to post to the mailing list > -(more info https://lists.linux-foundation.org/mailman/listinfo/bridge). > +.. kernel-doc:: net/bridge/br_private.h nit: Building htmldocs reports: ./net/bridge/br_private.h:240: warning: Function parameter or member 'tnode' not described in 'net_bridge_vlan' ./net/bridge/br_private.h:240: warning: Function parameter or member 'tinfo' not described in 'net_bridge_vlan' ...
On 11/10/23 12:15, 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. > > First add kAPI/uAPI and FAQ fields. These 2 fileds are only examples and > more APIs need to be added in future. > > Signed-off-by: Hangbin Liu <liuhangbin@gmail.com> > --- > Documentation/networking/bridge.rst | 83 +++++++++++++++++++++++++---- > 1 file changed, 73 insertions(+), 10 deletions(-) > > diff --git a/Documentation/networking/bridge.rst b/Documentation/networking/bridge.rst > index c859f3c1636e..d06c51960f45 100644 > --- a/Documentation/networking/bridge.rst > +++ b/Documentation/networking/bridge.rst > @@ -4,18 +4,81 @@ > 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 > +Bridge kAPI > +=========== > > -Additionally, the iproute2 utilities can be used to configure > -bridge devices. > +Here are some core structures of bridge code. > > -If you still have questions, don't hesitate to post to the mailing list > -(more info https://lists.linux-foundation.org/mailman/listinfo/bridge). > +.. 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: The bridge enum defination > + > +Bridge port netlink attributes > +------------------------------ > + > +.. kernel-doc:: include/uapi/linux/if_link.h > + :doc: The bridge port enum defination > + > +Bridge sysfs > +------------ > + > +All the sysfs parameters are also exported via the bridge netlink API. drop "the" here, all sysfs parameters > +Here you can find the explanation based on the correspond netlink attributes. "Here you can find sysfs parameter explanation based on the corresponding netlink attributes." But where is "Here"? Not sure what you mean. > + > +NOTE: the sysfs interface is deprecated and should not be extended if new > +options are added. > + > +.. kernel-doc:: net/bridge/br_sysfs_br.c > + :doc: The sysfs bridge attrs You use "sysfs parameters", here it is "sysfs attrs". Be consistent and use one of them. Drop "the" here. > + > +FAQ > +=== > + > +What does a bridge do? > +---------------------- > + > +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
On Mon, Nov 13, 2023 at 11:49:28AM +0200, Nikolay Aleksandrov wrote: > > +Bridge sysfs > > +------------ > > + > > +All the sysfs parameters are also exported via the bridge netlink API. > > drop "the" here, all sysfs parameters > > > +Here you can find the explanation based on the correspond netlink attributes. > > "Here you can find sysfs parameter explanation based on the > corresponding netlink attributes." > But where is "Here"? Not sure what you mean. > How about change it to All sysfs attributes are also exported via the bridge netlink API. You can find each attribute explanation based on the correspond netlink attribute. > > + > > +NOTE: the sysfs interface is deprecated and should not be extended if new > > +options are added. > > + > > +.. kernel-doc:: net/bridge/br_sysfs_br.c > > + :doc: The sysfs bridge attrs > > You use "sysfs parameters", here it is "sysfs attrs". Be consistent and > use one of them. Drop "the" here. Thanks Hangbin
diff --git a/Documentation/networking/bridge.rst b/Documentation/networking/bridge.rst index c859f3c1636e..d06c51960f45 100644 --- a/Documentation/networking/bridge.rst +++ b/Documentation/networking/bridge.rst @@ -4,18 +4,81 @@ 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 +Bridge kAPI +=========== -Additionally, the iproute2 utilities can be used to configure -bridge devices. +Here are some core structures of bridge code. -If you still have questions, don't hesitate to post to the mailing list -(more info https://lists.linux-foundation.org/mailman/listinfo/bridge). +.. 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: The bridge enum defination + +Bridge port netlink attributes +------------------------------ + +.. kernel-doc:: include/uapi/linux/if_link.h + :doc: The bridge port enum defination + +Bridge sysfs +------------ + +All the sysfs parameters are also exported via the bridge netlink API. +Here you can find the explanation based on the correspond netlink attributes. + +NOTE: the sysfs interface is deprecated and should not be extended if new +options are added. + +.. kernel-doc:: net/bridge/br_sysfs_br.c + :doc: The sysfs bridge attrs + +FAQ +=== + +What does a bridge do? +---------------------- + +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. First add kAPI/uAPI and FAQ fields. These 2 fileds are only examples and more APIs need to be added in future. Signed-off-by: Hangbin Liu <liuhangbin@gmail.com> --- Documentation/networking/bridge.rst | 83 +++++++++++++++++++++++++---- 1 file changed, 73 insertions(+), 10 deletions(-)