Skip to content

L
linux
Commit e322bacb authored by Vladimir Oltean's avatar Vladimir Oltean Committed by David S. Miller
Browse files
Options

Documentation: networking: dsa: demote subsections to simple emphasized words 

"make htmldocs" complains:
configuration.rst:165: WARNING: duplicate label networking/dsa/configuration:single port, other instance in (...)
configuration.rst:212: WARNING: duplicate label networking/dsa/configuration:bridge, other instance in (...)
configuration.rst:252: WARNING: duplicate label networking/dsa/configuration:gateway, other instance in (...)

And for good reason, because the "single port", "bridge" and "gateway"
use cases are replicated twice, once for normal taggers and twice for
DSA_TAG_PROTO_NONE. So when trying to reference these sections via a
hyperlink such as:

https://www.kernel.org/doc/html/latest/networking/dsa/configuration.html#single-port

it will always reference the first occurrence, and never the second one.

This change makes the "single port", "bridge" and "gateway"
configuration examples consistent with the formatting used in the
"Configuration showcases" subsection.
Signed-off-by: default avatarVladimir Oltean <vladimir.oltean@nxp.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 8794be45
Hide whitespace changes
Inline Side-by-side
Showing with 142 additions and 153 deletions
Documentation/networking/dsa/configuration.rst
View file @ e322bacb
...@@ -78,79 +78,73 @@ The tagging based configuration is desired and supported by the majority of ...@@ -78,79 +78,73 @@ The tagging based configuration is desired and supported by the majority of
DSA switches. These switches are capable to tag incoming and outgoing traffic DSA switches. These switches are capable to tag incoming and outgoing traffic
without using a VLAN based configuration. without using a VLAN based configuration.
single port *single port*
~~~~~~~~~~~ .. code-block:: sh
.. code-block:: sh
# configure each interface
ip addr add 192.0.2.1/30 dev lan1
ip addr add 192.0.2.5/30 dev lan2
ip addr add 192.0.2.9/30 dev lan3
# The master interface needs to be brought up before the slave ports.
ip link set eth0 up
# bring up the slave interfaces # configure each interface
ip link set lan1 up ip addr add 192.0.2.1/30 dev lan1
ip link set lan2 up ip addr add 192.0.2.5/30 dev lan2
ip link set lan3 up ip addr add 192.0.2.9/30 dev lan3
bridge # The master interface needs to be brought up before the slave ports.
~~~~~~ ip link set eth0 up
.. code-block:: sh # bring up the slave interfaces
ip link set lan1 up
ip link set lan2 up
ip link set lan3 up
# The master interface needs to be brought up before the slave ports. *bridge*
ip link set eth0 up .. code-block:: sh
# bring up the slave interfaces # The master interface needs to be brought up before the slave ports.
ip link set lan1 up ip link set eth0 up
ip link set lan2 up
ip link set lan3 up
# create bridge # bring up the slave interfaces
ip link add name br0 type bridge ip link set lan1 up
ip link set lan2 up
ip link set lan3 up
# add ports to bridge # create bridge
ip link set dev lan1 master br0 ip link add name br0 type bridge
ip link set dev lan2 master br0
ip link set dev lan3 master br0
# configure the bridge # add ports to bridge
ip addr add 192.0.2.129/25 dev br0 ip link set dev lan1 master br0
ip link set dev lan2 master br0
ip link set dev lan3 master br0
# bring up the bridge # configure the bridge
ip link set dev br0 up ip addr add 192.0.2.129/25 dev br0
gateway # bring up the bridge
~~~~~~~ ip link set dev br0 up
.. code-block:: sh *gateway*
.. code-block:: sh
# The master interface needs to be brought up before the slave ports. # The master interface needs to be brought up before the slave ports.
ip link set eth0 up ip link set eth0 up
# bring up the slave interfaces # bring up the slave interfaces
ip link set wan up ip link set wan up
ip link set lan1 up ip link set lan1 up
ip link set lan2 up ip link set lan2 up
# configure the upstream port # configure the upstream port
ip addr add 192.0.2.1/30 dev wan ip addr add 192.0.2.1/30 dev wan
# create bridge # create bridge
ip link add name br0 type bridge ip link add name br0 type bridge
# add ports to bridge # add ports to bridge
ip link set dev lan1 master br0 ip link set dev lan1 master br0
ip link set dev lan2 master br0 ip link set dev lan2 master br0
# configure the bridge # configure the bridge
ip addr add 192.0.2.129/25 dev br0 ip addr add 192.0.2.129/25 dev br0
# bring up the bridge # bring up the bridge
ip link set dev br0 up ip link set dev br0 up
.. _dsa-vlan-configuration: .. _dsa-vlan-configuration:
...@@ -161,132 +155,127 @@ A minority of switches are not capable to use a taging protocol ...@@ -161,132 +155,127 @@ A minority of switches are not capable to use a taging protocol
(DSA_TAG_PROTO_NONE). These switches can be configured by a VLAN based (DSA_TAG_PROTO_NONE). These switches can be configured by a VLAN based
configuration. configuration.
single port *single port*
~~~~~~~~~~~ The configuration can only be set up via VLAN tagging and bridge setup.
The configuration can only be set up via VLAN tagging and bridge setup.
.. code-block:: sh
# tag traffic on CPU port
ip link add link eth0 name eth0.1 type vlan id 1
ip link add link eth0 name eth0.2 type vlan id 2
ip link add link eth0 name eth0.3 type vlan id 3
# The master interface needs to be brought up before the slave ports. .. code-block:: sh
ip link set eth0 up
ip link set eth0.1 up
ip link set eth0.2 up
ip link set eth0.3 up
# bring up the slave interfaces # tag traffic on CPU port
ip link set lan1 up ip link add link eth0 name eth0.1 type vlan id 1
ip link set lan2 up ip link add link eth0 name eth0.2 type vlan id 2
ip link set lan3 up ip link add link eth0 name eth0.3 type vlan id 3
# create bridge # The master interface needs to be brought up before the slave ports.
ip link add name br0 type bridge ip link set eth0 up
ip link set eth0.1 up
ip link set eth0.2 up
ip link set eth0.3 up
# activate VLAN filtering # bring up the slave interfaces
ip link set dev br0 type bridge vlan_filtering 1 ip link set lan1 up
ip link set lan2 up
ip link set lan3 up
# add ports to bridges # create bridge
ip link set dev lan1 master br0 ip link add name br0 type bridge
ip link set dev lan2 master br0
ip link set dev lan3 master br0
# tag traffic on ports # activate VLAN filtering
bridge vlan add dev lan1 vid 1 pvid untagged ip link set dev br0 type bridge vlan_filtering 1
bridge vlan add dev lan2 vid 2 pvid untagged
bridge vlan add dev lan3 vid 3 pvid untagged
# configure the VLANs # add ports to bridges
ip addr add 192.0.2.1/30 dev eth0.1 ip link set dev lan1 master br0
ip addr add 192.0.2.5/30 dev eth0.2 ip link set dev lan2 master br0
ip addr add 192.0.2.9/30 dev eth0.3 ip link set dev lan3 master br0
# bring up the bridge devices # tag traffic on ports
ip link set br0 up bridge vlan add dev lan1 vid 1 pvid untagged
bridge vlan add dev lan2 vid 2 pvid untagged
bridge vlan add dev lan3 vid 3 pvid untagged
# configure the VLANs
ip addr add 192.0.2.1/30 dev eth0.1
ip addr add 192.0.2.5/30 dev eth0.2
ip addr add 192.0.2.9/30 dev eth0.3
bridge # bring up the bridge devices
~~~~~~ ip link set br0 up
.. code-block:: sh
# tag traffic on CPU port *bridge*
ip link add link eth0 name eth0.1 type vlan id 1 .. code-block:: sh
# The master interface needs to be brought up before the slave ports. # tag traffic on CPU port
ip link set eth0 up ip link add link eth0 name eth0.1 type vlan id 1
ip link set eth0.1 up
# bring up the slave interfaces # The master interface needs to be brought up before the slave ports.
ip link set lan1 up ip link set eth0 up
ip link set lan2 up ip link set eth0.1 up
ip link set lan3 up
# create bridge # bring up the slave interfaces
ip link add name br0 type bridge ip link set lan1 up
ip link set lan2 up
ip link set lan3 up
# activate VLAN filtering # create bridge
ip link set dev br0 type bridge vlan_filtering 1 ip link add name br0 type bridge
# add ports to bridge # activate VLAN filtering
ip link set dev lan1 master br0 ip link set dev br0 type bridge vlan_filtering 1
ip link set dev lan2 master br0
ip link set dev lan3 master br0
ip link set eth0.1 master br0
# tag traffic on ports # add ports to bridge
bridge vlan add dev lan1 vid 1 pvid untagged ip link set dev lan1 master br0
bridge vlan add dev lan2 vid 1 pvid untagged ip link set dev lan2 master br0
bridge vlan add dev lan3 vid 1 pvid untagged ip link set dev lan3 master br0
ip link set eth0.1 master br0
# configure the bridge # tag traffic on ports
ip addr add 192.0.2.129/25 dev br0 bridge vlan add dev lan1 vid 1 pvid untagged
bridge vlan add dev lan2 vid 1 pvid untagged
bridge vlan add dev lan3 vid 1 pvid untagged
# bring up the bridge # configure the bridge
ip link set dev br0 up ip addr add 192.0.2.129/25 dev br0
gateway # bring up the bridge
~~~~~~~ ip link set dev br0 up
.. code-block:: sh *gateway*
.. code-block:: sh
# tag traffic on CPU port # tag traffic on CPU port
ip link add link eth0 name eth0.1 type vlan id 1 ip link add link eth0 name eth0.1 type vlan id 1
ip link add link eth0 name eth0.2 type vlan id 2 ip link add link eth0 name eth0.2 type vlan id 2
# The master interface needs to be brought up before the slave ports. # The master interface needs to be brought up before the slave ports.
ip link set eth0 up ip link set eth0 up
ip link set eth0.1 up ip link set eth0.1 up
ip link set eth0.2 up ip link set eth0.2 up
# bring up the slave interfaces # bring up the slave interfaces
ip link set wan up ip link set wan up
ip link set lan1 up ip link set lan1 up
ip link set lan2 up ip link set lan2 up
# create bridge # create bridge
ip link add name br0 type bridge ip link add name br0 type bridge
# activate VLAN filtering # activate VLAN filtering
ip link set dev br0 type bridge vlan_filtering 1 ip link set dev br0 type bridge vlan_filtering 1
# add ports to bridges # add ports to bridges
ip link set dev wan master br0 ip link set dev wan master br0
ip link set eth0.1 master br0 ip link set eth0.1 master br0
ip link set dev lan1 master br0 ip link set dev lan1 master br0
ip link set dev lan2 master br0 ip link set dev lan2 master br0
# tag traffic on ports # tag traffic on ports
bridge vlan add dev lan1 vid 1 pvid untagged bridge vlan add dev lan1 vid 1 pvid untagged
bridge vlan add dev lan2 vid 1 pvid untagged bridge vlan add dev lan2 vid 1 pvid untagged
bridge vlan add dev wan vid 2 pvid untagged bridge vlan add dev wan vid 2 pvid untagged
# configure the VLANs # configure the VLANs
ip addr add 192.0.2.1/30 dev eth0.2 ip addr add 192.0.2.1/30 dev eth0.2
ip addr add 192.0.2.129/25 dev br0 ip addr add 192.0.2.129/25 dev br0
# bring up the bridge devices # bring up the bridge devices
ip link set br0 up ip link set br0 up
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7