From e82ebbd96e2ba73276e2f1b6d7f9c2d8a9442c3f Mon Sep 17 00:00:00 2001 From: Viliam Luc Date: Thu, 28 Oct 2021 15:05:53 +0200 Subject: 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 Change-Id: I1ac1099d38935971d47491dde905715345d3935c --- ...1x710-ethip6ip6-ip6base-srv6enc1sid-scapy.robot | 37 ++++++++++++---------- ...rhip6-ip6base-srv6enc2sids-nodecaps-scapy.robot | 33 ++++++++++--------- ...0-ethip6srhip6-ip6base-srv6enc2sids-scapy.robot | 33 ++++++++++--------- ...-ethip6srhip6-ip6base-srv6proxy-dyn-scapy.robot | 33 ++++++++++--------- ...ethip6srhip6-ip6base-srv6proxy-masq-scapy.robot | 33 ++++++++++--------- ...ethip6srhip6-ip6base-srv6proxy-stat-scapy.robot | 33 ++++++++++--------- 6 files changed, 110 insertions(+), 92 deletions(-) (limited to 'tests/vpp/device/srv6') diff --git a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6ip6-ip6base-srv6enc1sid-scapy.robot b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6ip6-ip6base-srv6enc1sid-scapy.robot index bbb3027953..433266e1f3 100644 --- a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6ip6-ip6base-srv6enc1sid-scapy.robot +++ b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6ip6-ip6base-srv6enc1sid-scapy.robot @@ -15,8 +15,8 @@ | Resource | resources/libraries/robot/shared/default.robot | | Force Tags | 2_NODE_SINGLE_LINK_TOPO | DEVICETEST | HW_ENV | DCR_ENV | SCAPY -| ... | NIC_Intel-X710 | ETH | IP6FWD | FEATURE | SRv6 | SRv6_1SID | DRV_VFIO_PCI -| ... | RXQ_SIZE_0 | TXQ_SIZE_0 +| ... | NIC_Intel-X710 | ETH | IP6FWD | FEATURE | SRv6 | SRv6_1SID +| ... | DRV_VFIO_PCI | RXQ_SIZE_0 | TXQ_SIZE_0 | ... | ethip6ip6-ip6base-srv6enc1sid | | Suite Setup | Setup suite topology interfaces | scapy @@ -25,20 +25,23 @@ | | Test Template | Local Template | -| Documentation | *Segment routing over IPv6 dataplane with one SID\ -| ... | (SRH not inserted) test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **Segment routing over IPv6 dataplane with one SID \ +| ... | (SRH not inserted) test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 configure physical interface IPv6\ -| ... | addresses, static ARP record, route and IPv6 forwarding over SRv6\ +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 configure physical interface \ +| ... | IPv6 addresses, static ARP record, route and IPv6 forwarding over SRv6 \ | ... | with one SID - Segment Routing Header not inserted. -| ... | *[Ver] TG verification:* ETH-IP6 packet is sent from TG to DUT1 in one\ -| ... | direction. Packet is received and verified for correctness on TG. Then\ -| ... | ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet is\ -| ... | received and verified for correctness on TG. -| ... | *[Ref] Applicable standard specifications:* SRv6 Network Programming -\ -| ... | draft 3. +| ... | +| ... | - **[Ver] TG verification:** ETH-IP6 packet is sent from TG to DUT1 in \ +| ... | one direction. Packet is received and verified for correctness on TG. \ +| ... | Then ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet \ +| ... | is received and verified for correctness on TG. +| ... | +| ... | - **[Ref] Applicable standard specifications:** SRv6 Network \ +| ... | Programming - draft 3. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -72,10 +75,10 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT1 is configured with IPv6 routing and static route,\ -| | ... | SR policy and steering policy for one direction and one SR\ +| | ... | - **[Cfg]** DUT1 is configured with IPv6 routing and static route, \ +| | ... | SR policy and steering policy for one direction and one SR \ | | ... | behaviour (function) - End.DX6 - for other direction. -| | ... | [Ver] Make TG send IPv6 packets routed over DUT1 interfaces.\ +| | ... | - **[Ver]** Make TG send IPv6 packets routed over DUT1 interfaces. \ | | ... | Make TG verify IPv6 packets are correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6enc2sids-nodecaps-scapy.robot b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6enc2sids-nodecaps-scapy.robot index 6635779e48..ff172552b7 100644 --- a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6enc2sids-nodecaps-scapy.robot +++ b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6enc2sids-nodecaps-scapy.robot @@ -26,20 +26,23 @@ | | Test Template | Local Template | -| Documentation | *Segment routing over IPv6 dataplane with two SIDs\ -| ... | (SRH inserted) test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **Segment routing over IPv6 dataplane with two SIDs \ +| ... | (SRH inserted) test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 configure physical interface IPv6\ -| ... | addresses, static ARP record, route and IPv6 forwarding over SRv6\ +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 configure physical interface \ +| ... | IPv6 addresses, static ARP record, route and IPv6 forwarding over SRv6 \ | ... | with two SIDs - Segment Routing Header inserted. -| ... | *[Ver] TG verification:* ETH-IP6 packet is sent from TG to DUT1 in one\ -| ... | direction. Packet is received and verified for correctness on TG. Then\ -| ... | ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet is\ -| ... | received and verified for correctness on TG. -| ... | *[Ref] Applicable standard specifications:* SRv6 Network Programming -\ -| ... | draft 3. +| ... | +| ... | - **[Ver] TG verification:** ETH-IP6 packet is sent from TG to DUT1 in \ +| ... | one direction. Packet is received and verified for correctness on TG. \ +| ... | Then ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet \ +| ... | is received and verified for correctness on TG. +| ... | +| ... | - **[Ref] Applicable standard specifications:** SRv6 Network \ +| ... | Programming - draft 3. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -75,10 +78,10 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT1 is configured with IPv6 routing and static route,\ -| | ... | SR policy and steering policy for one direction and one SR\ +| | ... | - **[Cfg]** DUT1 is configured with IPv6 routing and static route, \ +| | ... | SR policy and steering policy for one direction and one SR \ | | ... | behaviour (function) - End - for other direction. -| | ... | [Ver] Make TG send IPv6 packets routed over DUT1 interfaces.\ +| | ... | - **[Ver]** Make TG send IPv6 packets routed over DUT1 interfaces. \ | | ... | Make TG verify IPv6 packets are correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6enc2sids-scapy.robot b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6enc2sids-scapy.robot index 58bc7b66ab..6f69423b11 100644 --- a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6enc2sids-scapy.robot +++ b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6enc2sids-scapy.robot @@ -26,20 +26,23 @@ | | Test Template | Local Template | -| Documentation | *Segment routing over IPv6 dataplane with two SIDs\ -| ... | (SRH inserted) test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **Segment routing over IPv6 dataplane with two SIDs \ +| ... | (SRH inserted) test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 configure physical interface IPv6\ -| ... | addresses, static ARP record, route and IPv6 forwarding over SRv6\ +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 configure physical interface \ +| ... | IPv6 addresses, static ARP record, route and IPv6 forwarding over SRv6 \ | ... | with two SIDs - Segment Routing Header inserted. -| ... | *[Ver] TG verification:* ETH-IP6 packet is sent from TG to DUT1 in one\ -| ... | direction. Packet is received and verified for correctness on TG. Then\ -| ... | ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet is\ -| ... | received and verified for correctness on TG. -| ... | *[Ref] Applicable standard specifications:* SRv6 Network Programming -\ -| ... | draft 3. +| ... | +| ... | - **[Ver] TG verification:** ETH-IP6 packet is sent from TG to DUT1 in \ +| ... | one direction. Packet is received and verified for correctness on TG. \ +| ... | Then ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet \ +| ... | is received and verified for correctness on TG. +| ... | +| ... | - **[Ref] Applicable standard specifications:** SRv6 Network \ +| ... | Programming - draft 3. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -75,10 +78,10 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT1 is configured with IPv6 routing and static route,\ -| | ... | SR policy and steering policy for one direction and two SR\ +| | ... | - **[Cfg]** DUT1 is configured with IPv6 routing and static route, \ +| | ... | SR policy and steering policy for one direction and two SR \ | | ... | behaviours (functions) - End and End.DX6 - for other direction. -| | ... | [Ver] Make TG send IPv6 packets routed over DUT1 interfaces.\ +| | ... | - **[Ver]** Make TG send IPv6 packets routed over DUT1 interfaces. \ | | ... | Make TG verify IPv6 packets are correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-dyn-scapy.robot b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-dyn-scapy.robot index 2bb20ace6e..dd5f6facac 100644 --- a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-dyn-scapy.robot +++ b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-dyn-scapy.robot @@ -26,20 +26,23 @@ | | Test Template | Local Template | -| Documentation | *Segment routing over IPv6 dataplane with Dynamic\ -| ... | SRv6 proxy test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **Segment routing over IPv6 dataplane with Dynamic \ +| ... | SRv6 proxy test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 configure physical interface IPv6\ -| ... | addresses, static ARP record, route and IPv6 forwarding over SRv6\ +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 configure physical interface \ +| ... | IPv6 addresses, static ARP record, route and IPv6 forwarding over SRv6 \ | ... | with three SIDs - Segment Routing Header inserted. -| ... | *[Ver] TG verification:* ETH-IP6 packet is sent from TG to DUT1 in one\ -| ... | direction. Packet is received and verified for correctness on TG. Then\ -| ... | ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet is\ -| ... | received and verified for correctness on TG. -| ... | *[Ref] Applicable standard specifications:* SRv6 Network Programming -\ -| ... | draft 3. +| ... | +| ... | - **[Ver] TG verification:** ETH-IP6 packet is sent from TG to DUT1 in \ +| ... | one direction. Packet is received and verified for correctness on TG. \ +| ... | Then ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet \ +| ... | is received and verified for correctness on TG. +| ... | +| ... | - **[Ref] Applicable standard specifications:** SRv6 Network \ +| ... | Programming - draft 3. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | memif_plugin.so @@ -88,10 +91,10 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT1 is configured with IPv6 routing and static route,\ -| | ... | SR policy and steering policy for one direction and one SR\ +| | ... | - **[Cfg]** DUT1 is configured with IPv6 routing and static route, \ +| | ... | SR policy and steering policy for one direction and one SR \ | | ... | behaviour (function) - End.AD - for other direction. -| | ... | [Ver] Make TG send IPv6 packets routed over DUT1 interfaces.\ +| | ... | - **[Ver]** Make TG send IPv6 packets routed over DUT1 interfaces. \ | | ... | Make TG verify IPv6 packets are correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-masq-scapy.robot b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-masq-scapy.robot index 44ea258288..379310e040 100644 --- a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-masq-scapy.robot +++ b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-masq-scapy.robot @@ -26,20 +26,23 @@ | | Test Template | Local Template | -| Documentation | *Segment routing over IPv6 dataplane with Masquerading\ -| ... | SRv6 proxy test cases* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **Segment routing over IPv6 dataplane with Masquerading \ +| ... | SRv6 proxy test cases** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 configure physical interface IPv6\ -| ... | addresses, static ARP record, route and IPv6 forwarding over SRv6\ +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 configure physical interface \ +| ... | IPv6 addresses, static ARP record, route and IPv6 forwarding over SRv6 \ | ... | with three SIDs - Segment Routing Header inserted. -| ... | *[Ver] TG verification:* ETH-IP6 packet is sent from TG to DUT1 in one\ -| ... | direction. Packet is received and verified for correctness on TG. Then\ -| ... | ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet is\ -| ... | received and verified for correctness on TG. -| ... | *[Ref] Applicable standard specifications:* SRv6 Network Programming -\ -| ... | draft 3. +| ... | +| ... | - **[Ver] TG verification:** ETH-IP6 packet is sent from TG to DUT1 in \ +| ... | one direction. Packet is received and verified for correctness on TG. \ +| ... | Then ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet \ +| ... | is received and verified for correctness on TG. +| ... | +| ... | - **[Ref] Applicable standard specifications:** SRv6 Network \ +| ... | Programming - draft 3. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | memif_plugin.so @@ -88,10 +91,10 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT1 is configured with IPv6 routing and static route,\ -| | ... | SR policy and steering policy for one direction and one SR\ +| | ... | - **[Cfg]** DUT1 is configured with IPv6 routing and static route, \ +| | ... | SR policy and steering policy for one direction and one SR \ | | ... | behaviour (function) - End.AM - for other direction. -| | ... | [Ver] Make TG send IPv6 packets routed over DUT1 interfaces.\ +| | ... | - **[Ver]** Make TG send IPv6 packets routed over DUT1 interfaces. \ | | ... | Make TG verify IPv6 packets are correct. | | | | ... | *Arguments:* diff --git a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-stat-scapy.robot b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-stat-scapy.robot index 6357fde054..43cd587015 100644 --- a/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-stat-scapy.robot +++ b/tests/vpp/device/srv6/2n1l-10ge2p1x710-ethip6srhip6-ip6base-srv6proxy-stat-scapy.robot @@ -26,20 +26,23 @@ | | Test Template | Local Template | -| Documentation | *Segment routing over IPv6 dataplane with Static\ -| ... | SRv6 proxy test cases.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **Segment routing over IPv6 dataplane with Static \ +| ... | SRv6 proxy test cases.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 configure physical interface IPv6\ -| ... | addresses, static ARP record, route and IPv6 forwarding over SRv6\ +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 configure physical interface \ +| ... | IPv6 addresses, static ARP record, route and IPv6 forwarding over SRv6 \ | ... | with three SIDs - Segment Routing Header inserted. -| ... | *[Ver] TG verification:* ETH-IP6 packet is sent from TG to DUT1 in one\ -| ... | direction. Packet is received and verified for correctness on TG. Then\ -| ... | ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet is\ -| ... | received and verified for correctness on TG. -| ... | *[Ref] Applicable standard specifications:* SRv6 Network Programming -\ -| ... | draft 3. +| ... | +| ... | - **[Ver] TG verification:** ETH-IP6 packet is sent from TG to DUT1 in \ +| ... | one direction. Packet is received and verified for correctness on TG. \ +| ... | Then ETH-IP6-IP6 packet is sent from TG in opposite direction. Packet \ +| ... | is received and verified for correctness on TG. +| ... | +| ... | - **[Ref] Applicable standard specifications:** SRv6 Network \ +| ... | Programming - draft 3. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | memif_plugin.so @@ -88,10 +91,10 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] DUT1 is configured with IPv6 routing and static route,\ -| | ... | SR policy and steering policy for one direction and one SR\ +| | ... | - **[Cfg]** DUT1 is configured with IPv6 routing and static route, \ +| | ... | SR policy and steering policy for one direction and one SR \ | | ... | behaviour (function) - End.AS - for other direction. -| | ... | [Ver] Make TG send IPv6 packets routed over DUT1 interfaces.\ +| | ... | - **[Ver]** Make TG send IPv6 packets routed over DUT1 interfaces. \ | | ... | Make TG verify IPv6 packets are correct. | | | | ... | *Arguments:* -- cgit 1.2.3-korg