diff mbox series

[RFC,PATCHv3,net-next,06/10] docs: bridge: add VLAN doc

Message ID 20231110101548.1900519-7-liuhangbin@gmail.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series Doc: update bridge doc | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 8 this patch: 8
netdev/cc_maintainers warning 2 maintainers not CCed: linux-doc@vger.kernel.org corbet@lwn.net
netdev/build_clang success Errors and warnings before: 8 this patch: 8
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 8 this patch: 8
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 35 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Hangbin Liu Nov. 10, 2023, 10:15 a.m. UTC
Add VLAN part for bridge document.

Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
---
 Documentation/networking/bridge.rst | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

Comments

Nikolay Aleksandrov Nov. 13, 2023, 9:54 a.m. UTC | #1
On 11/10/23 12:15, Hangbin Liu wrote:
> Add VLAN part for bridge document.
> 
> Signed-off-by: Hangbin Liu <liuhangbin@gmail.com>
> ---
>   Documentation/networking/bridge.rst | 29 +++++++++++++++++++++++++++++
>   1 file changed, 29 insertions(+)
> 
> diff --git a/Documentation/networking/bridge.rst b/Documentation/networking/bridge.rst
> index e168f86ddd82..88dfc6eb0919 100644
> --- a/Documentation/networking/bridge.rst
> +++ b/Documentation/networking/bridge.rst
> @@ -135,6 +135,35 @@ Proper configuration of STP parameters, such as the bridge priority, can
>   influence which bridge becomes the Root Bridge. Careful configuration can
>   optimize network performance and path selection.
>   
> +VLAN
> +====
> +
> +A LAN (Local Area Network) is a network that covers a small geographic area,
> +typically within a single building or a campus. LANs are used to connect
> +computers, servers, printers, and other networked devices within a localized
> +area. LANs can be wired (using Ethernet cables) or wireless (using Wi-Fi).
> +
> +A VLAN (Virtual Local Area Network) is a logical segmentation of a physical
> +network into multiple isolated broadcast domains. VLANs are used to divide
> +a single physical LAN into multiple virtual LANs, allowing different groups of
> +devices to communicate as if they were on separate physical networks.
> +
> +Typically there are two VLAN implementations, IEEE 802.1Q and IEEE 802.1ad
> +(also known as QinQ). IEEE 802.1Q is a standard for VLAN tagging in Ethernet
> +networks. It allows network administrators to create logical VLANs on a
> +physical network and tag Ethernet frames with VLAN information, which is
> +called *VLAN-tagged frames*. IEEE 802.1ad, commonly known as QinQ or Double
> +VLAN, is an extension of the IEEE 802.1Q standard. QinQ allows for the
> +stacking of multiple VLAN tags within a single Ethernet frame. The Linux
> +bridge supports both the IEEE 802.1Q and `802.1AD
> +<https://lore.kernel.org/netdev/1402401565-15423-1-git-send-email-makita.toshiaki@lab.ntt.co.jp/>`_
> +protocol for VLAN tagging.
> +
> +The `VLAN filtering <https://lore.kernel.org/netdev/1360792820-14116-1-git-send-email-vyasevic@redhat.com/>`_

drop "The", just VLAN filtering

> +on bridge is disabled by default. After enabling VLAN

on a bridge

> +filter on bridge, the bridge can handle VLAN-tagged frames and forward them

filtering on a bridge, it will

But here it sounds a bit misleading, as if vlan-tagged frames are not 
handled otherwise. They are, just vlan tags are not considered when
making forwarding decisions (e.g. FDB lookup).

> +to the appropriate destinations.
> +
>   FAQ
>   ===
>
Hangbin Liu Nov. 15, 2023, 9:23 a.m. UTC | #2
On Mon, Nov 13, 2023 at 11:54:36AM +0200, Nikolay Aleksandrov wrote:
> > +The `VLAN filtering <https://lore.kernel.org/netdev/1360792820-14116-1-git-send-email-vyasevic@redhat.com/>`_
> 
> drop "The", just VLAN filtering
> 
> > +on bridge is disabled by default. After enabling VLAN
> 
> on a bridge
> 
> > +filter on bridge, the bridge can handle VLAN-tagged frames and forward them
> 
> filtering on a bridge, it will
> 
> But here it sounds a bit misleading, as if vlan-tagged frames are not
> handled otherwise. They are, just vlan tags are not considered when
> making forwarding decisions (e.g. FDB lookup).

How about:

VLAN filtering on a bridge is disabled by default. After enabling VLAN filtering
on a bridge, it will start forwarding frames to appropriate destinations based
on their VLAN tag.

Thanks
Hangbin
Nikolay Aleksandrov Nov. 15, 2023, 9:47 a.m. UTC | #3
On 11/15/23 11:23, Hangbin Liu wrote:
> On Mon, Nov 13, 2023 at 11:54:36AM +0200, Nikolay Aleksandrov wrote:
>>> +The `VLAN filtering <https://lore.kernel.org/netdev/1360792820-14116-1-git-send-email-vyasevic@redhat.com/>`_
>>
>> drop "The", just VLAN filtering
>>
>>> +on bridge is disabled by default. After enabling VLAN
>>
>> on a bridge
>>
>>> +filter on bridge, the bridge can handle VLAN-tagged frames and forward them
>>
>> filtering on a bridge, it will
>>
>> But here it sounds a bit misleading, as if vlan-tagged frames are not
>> handled otherwise. They are, just vlan tags are not considered when
>> making forwarding decisions (e.g. FDB lookup).
> 
> How about:
> 
> VLAN filtering on a bridge is disabled by default. After enabling VLAN filtering
> on a bridge, it will start forwarding frames to appropriate destinations based
> on their VLAN tag.
> 
> Thanks
> Hangbin

How about a little tweak like: ... it will start forwarding frames to
appropriate destinations based on their destination MAC address and VLAN
tag (both must match).
Hangbin Liu Nov. 15, 2023, 9:55 a.m. UTC | #4
On Wed, Nov 15, 2023 at 11:47:02AM +0200, Nikolay Aleksandrov wrote:
> > > But here it sounds a bit misleading, as if vlan-tagged frames are not
> > > handled otherwise. They are, just vlan tags are not considered when
> > > making forwarding decisions (e.g. FDB lookup).
> > 
> > How about:
> > 
> > VLAN filtering on a bridge is disabled by default. After enabling VLAN filtering
> > on a bridge, it will start forwarding frames to appropriate destinations based
> > on their VLAN tag.
> 
> How about a little tweak like: ... it will start forwarding frames to
> appropriate destinations based on their destination MAC address and VLAN
> tag (both must match).

Sure, thanks for your modification.

Hangbin
diff mbox series

Patch

diff --git a/Documentation/networking/bridge.rst b/Documentation/networking/bridge.rst
index e168f86ddd82..88dfc6eb0919 100644
--- a/Documentation/networking/bridge.rst
+++ b/Documentation/networking/bridge.rst
@@ -135,6 +135,35 @@  Proper configuration of STP parameters, such as the bridge priority, can
 influence which bridge becomes the Root Bridge. Careful configuration can
 optimize network performance and path selection.
 
+VLAN
+====
+
+A LAN (Local Area Network) is a network that covers a small geographic area,
+typically within a single building or a campus. LANs are used to connect
+computers, servers, printers, and other networked devices within a localized
+area. LANs can be wired (using Ethernet cables) or wireless (using Wi-Fi).
+
+A VLAN (Virtual Local Area Network) is a logical segmentation of a physical
+network into multiple isolated broadcast domains. VLANs are used to divide
+a single physical LAN into multiple virtual LANs, allowing different groups of
+devices to communicate as if they were on separate physical networks.
+
+Typically there are two VLAN implementations, IEEE 802.1Q and IEEE 802.1ad
+(also known as QinQ). IEEE 802.1Q is a standard for VLAN tagging in Ethernet
+networks. It allows network administrators to create logical VLANs on a
+physical network and tag Ethernet frames with VLAN information, which is
+called *VLAN-tagged frames*. IEEE 802.1ad, commonly known as QinQ or Double
+VLAN, is an extension of the IEEE 802.1Q standard. QinQ allows for the
+stacking of multiple VLAN tags within a single Ethernet frame. The Linux
+bridge supports both the IEEE 802.1Q and `802.1AD
+<https://lore.kernel.org/netdev/1402401565-15423-1-git-send-email-makita.toshiaki@lab.ntt.co.jp/>`_
+protocol for VLAN tagging.
+
+The `VLAN filtering <https://lore.kernel.org/netdev/1360792820-14116-1-git-send-email-vyasevic@redhat.com/>`_
+on bridge is disabled by default. After enabling VLAN
+filter on bridge, the bridge can handle VLAN-tagged frames and forward them
+to the appropriate destinations.
+
 FAQ
 ===