diff options
author | Viliam Luc <vluc@cisco.com> | 2021-10-28 15:05:53 +0200 |
---|---|---|
committer | Tibor Frank <tifrank@cisco.com> | 2021-12-13 10:57:25 +0000 |
commit | e82ebbd96e2ba73276e2f1b6d7f9c2d8a9442c3f (patch) | |
tree | 8548662c60534211b7eb34f2f2881636ec3797b9 /tests/vpp/device/l2bd | |
parent | f87931f3c85fe71bb3124e787168abafc5874c54 (diff) |
doc: fixing documentation structure
When building documentation using sphinx we see ~1200 similar warnings [0]
[0] - https://s3-logs.fd.io/vex-yul-rot-jenkins-1/csit-verify-tox-master-ubuntu2004-x86_64/3289/doc_verify.log.gz
These warning are harmless and can be fixed later
Signed-off-by: Viliam Luc <vluc@cisco.com>
Change-Id: I1ac1099d38935971d47491dde905715345d3935c
Diffstat (limited to 'tests/vpp/device/l2bd')
6 files changed, 105 insertions, 81 deletions
diff --git a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-iacl1sf-scapy.robot b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-iacl1sf-scapy.robot index 3cfe804df0..6aefa63bea 100644 --- a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-iacl1sf-scapy.robot +++ b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-iacl1sf-scapy.robot @@ -26,18 +26,22 @@ | | Test Template | Local Template | -| Documentation | *L2BD test cases with ACL* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **L2BD test cases with ACL** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 on all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 bridge domain\ -| ... | and MAC learning enabled.Required ACL rules are applied to input\ -| ... | paths of both DUT1 intefaces.\ -| ... | *[Ver] TG verification:* Test IPv4 packets are sent in one direction \ -| ... | by TG on link to DUT1; on receive TG verifies packets for correctness \ -| ... | and drops as applicable. -| ... | *[Ref] Applicable standard specifications:* +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 on all links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 bridge \ +| ... | domain and MAC learning enabled. Required ACL rules are applied to \ +| ... | input paths of both DUT1 intefaces. +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets are sent in one \ +| ... | direction by TG on link to DUT1; on receive TG verifies packets for \ +| ... | correctness and drops as applicable. +| ... | +| ... | - **[Ref] Applicable standard specifications:** *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | acl_plugin.so @@ -68,9 +72,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2BD config with ACLs. -| | ... | [Ver] Make TG send IPv4 packet in one direction between two\ -| | ... | of its interfaces to be switched by DUT to and from docker.\ +| | ... | - **[Cfg]** DUT runs L2BD config with ACLs. +| | ... | - **[Ver]** Make TG send IPv4 packet in one direction between two \ +| | ... | of its interfaces to be switched by DUT to and from docker. \ | | ... | Make TG verify IPv4 packet is correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-iacl1sl-scapy.robot b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-iacl1sl-scapy.robot index 8ca92c5385..49690e0f18 100644 --- a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-iacl1sl-scapy.robot +++ b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-iacl1sl-scapy.robot @@ -26,18 +26,22 @@ | | Test Template | Local Template | -| Documentation | *L2BD test cases with ACL* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **L2BD test cases with ACL** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 on all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 bridge domain\ -| ... | and MAC learning enabled.Required ACL rules are applied to input\ -| ... | paths of both DUT1 intefaces.\ -| ... | *[Ver] TG verification:* Test IPv4 packets are sent in one direction \ -| ... | by TG on link to DUT1; on receive TG verifies packets for correctness \ -| ... | and drops as applicable. -| ... | *[Ref] Applicable standard specifications:* +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 on all links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 bridge \ +| ... | domain and MAC learning enabled.Required ACL rules are applied to \ +| ... | input paths of both DUT1 intefaces. +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets are sent in one \ +| ... | direction by TG on link to DUT1; on receive TG verifies packets for \ +| ... | correctness and drops as applicable. +| ... | +| ... | - **[Ref] Applicable standard specifications:** *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | acl_plugin.so @@ -68,9 +72,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2BD config with ACLs. -| | ... | [Ver] Make TG send IPv4 packet in one direction between two\ -| | ... | of its interfaces to be switched by DUT to and from docker.\ +| | ... | - **[Cfg]** DUT runs L2BD config with ACLs. +| | ... | - **[Ver]** Make TG send IPv4 packet in one direction between two \ +| | ... | of its interfaces to be switched by DUT to and from docker. \ | | ... | Make TG verify IPv4 packet is correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-macip-iacl1sl-scapy.robot b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-macip-iacl1sl-scapy.robot index 2546608d85..fdefa02dc5 100644 --- a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-macip-iacl1sl-scapy.robot +++ b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-macip-iacl1sl-scapy.robot @@ -26,18 +26,22 @@ | | Test Template | Local Template | -| Documentation | *L2BD test cases with ACL* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **L2BD test cases with ACL** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 on all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 bridge domain\ -| ... | and MAC learning enabled.Required MACIP ACL rules are applied to input\ -| ... | paths of both DUT1 intefaces.\ -| ... | *[Ver] TG verification:* Test IPv4 packets are sent in one direction \ -| ... | by TG on link to DUT1; on receive TG verifies packets for correctness \ -| ... | and drops as applicable. -| ... | *[Ref] Applicable standard specifications:* +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 on all links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 bridge \ +| ... | domain and MAC learning enabled. Required ACL rules are applied to \ +| ... | input paths of both DUT1 intefaces. +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets are sent in one \ +| ... | direction by TG on link to DUT1; on receive TG verifies packets for \ +| ... | correctness and drops as applicable. +| ... | +| ... | - **[Ref] Applicable standard specifications:** *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | acl_plugin.so @@ -69,9 +73,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2BD config with ACLs. -| | ... | [Ver] Make TG send IPv4 packet in one direction between two\ -| | ... | of its interfaces to be switched by DUT to and from docker.\ +| | ... | - **[Cfg]** DUT runs L2BD config with ACLs. +| | ... | - **[Ver]** Make TG send IPv4 packet in one direction between two \ +| | ... | of its interfaces to be switched by DUT to and from docker. \ | | ... | Make TG verify IPv4 packet is correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-oacl1sf-scapy.robot b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-oacl1sf-scapy.robot index 7e71c42288..0d93313bda 100644 --- a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-oacl1sf-scapy.robot +++ b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-oacl1sf-scapy.robot @@ -26,18 +26,22 @@ | | Test Template | Local Template | -| Documentation | *L2BD test cases with ACL* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **L2BD test cases with ACL** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 on all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 bridge domain\ -| ... | and MAC learning enabled.Required ACL rules are applied to input\ -| ... | paths of both DUT1 intefaces.\ -| ... | *[Ver] TG verification:* Test IPv4 packets are sent in one direction \ -| ... | by TG on link to DUT1; on receive TG verifies packets for correctness \ -| ... | and drops as applicable. -| ... | *[Ref] Applicable standard specifications:* +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 on all links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 bridge \ +| ... | domain and MAC learning enabled.Required ACL rules are applied to \ +| ... | input paths of both DUT1 intefaces. +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets are sent in one \ +| ... | direction by TG on link to DUT1; on receive TG verifies packets for \ +| ... | correctness and drops as applicable. +| ... | +| ... | - **[Ref] Applicable standard specifications:** *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | acl_plugin.so @@ -68,9 +72,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2BD config with ACLs. -| | ... | [Ver] Make TG send IPv4 packet in one direction between two\ -| | ... | of its interfaces to be switched by DUT to and from docker.\ +| | ... | - **[Cfg]** DUT runs L2BD config with ACLs. +| | ... | - **[Ver]** Make TG send IPv4 packet in one direction between two \ +| | ... | of its interfaces to be switched by DUT to and from docker. \ | | ... | Make TG verify IPv4 packet is correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-oacl1sl-scapy.robot b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-oacl1sl-scapy.robot index 6636f1771d..c3c3301eed 100644 --- a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-oacl1sl-scapy.robot +++ b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-oacl1sl-scapy.robot @@ -26,18 +26,22 @@ | | Test Template | Local Template | -| Documentation | *L2BD test cases with ACL* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology\ +| Documentation | **L2BD test cases with ACL** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 on all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 bridge domain\ -| ... | and MAC learning enabled.Required ACL rules are applied to input\ -| ... | paths of both DUT1 intefaces.\ -| ... | *[Ver] TG verification:* Test IPv4 packets are sent in one direction \ -| ... | by TG on link to DUT1; on receive TG verifies packets for correctness \ -| ... | and drops as applicable. -| ... | *[Ref] Applicable standard specifications:* +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 on all links. +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 bridge \ +| ... | domain and MAC learning enabled.Required ACL rules are applied to \ +| ... | input paths of both DUT1 intefaces. +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets are sent in one \ +| ... | direction by TG on link to DUT1; on receive TG verifies packets for \ +| ... | correctness and drops as applicable. +| ... | +| ... | - **[Ref] Applicable standard specifications:** *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | acl_plugin.so @@ -68,9 +72,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT runs L2BD config with ACLs. -| | ... | [Ver] Make TG send IPv4 packet in one direction between two\ -| | ... | of its interfaces to be switched by DUT to and from docker.\ +| | ... | - **[Cfg]** DUT runs L2BD config with ACLs. +| | ... | - **[Ver]** Make TG send IPv4 packet in one direction between two \ +| | ... | of its interfaces to be switched by DUT to and from docker. \ | | ... | Make TG verify IPv4 packet is correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-scapy.robot b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-scapy.robot index 51026605ad..2e058b5bcc 100644 --- a/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-scapy.robot +++ b/tests/vpp/device/l2bd/2n1l-10ge2p1x710-ethip4-l2bdbasemaclrn-scapy.robot @@ -25,19 +25,23 @@ | | Test Template | Local Template | -| Documentation | *L2 bridge-domain test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node circular topology \ +| Documentation | **L2 bridge-domain test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node circular topology \ | ... | with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4 for L2 switching of IPv4.\ +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4 for L2 switching of IPv4. \ | ... | Both apply to all links. -| ... | *[Cfg] DUT configuration:* DUT1 is configured with L2 bridge-domain \ -| ... | switching. -| ... | *[Ver] TG verification:* Test IPv4 packets with IP protocol=61 \ -| ... | are sent in both directions by TG on links to DUT1; on receive TG \ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 is configured with L2 \ +| ... | cross-connect switching. +| ... | +| ... | - **[Ver] TG verification:** Test IPv4 packets with IP protocol=61 \ +| ... | are sent in both directions by TG on links to DUT1; on receive TG. \ | ... | verifies packets for correctness and their IPv4 src-addr, \ | ... | dst-addr and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC792 +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC792 *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -55,8 +59,8 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Ver] Make TG send IPv4 packets in both directions between two\ -| | ... | of its interfaces to be switched by DUT to and from docker; verify\ +| | ... | - **[Ver]** Make TG send IPv4 packets in both directions between two \ +| | ... | of its interfaces to be switched by DUT to and from docker; verify \ | | ... | all packets are received. | | | | ... | *Arguments:* |