diff options
author | 2021-10-28 15:05:53 +0200 | |
---|---|---|
committer | 2021-12-13 10:57:25 +0000 | |
commit | e82ebbd96e2ba73276e2f1b6d7f9c2d8a9442c3f (patch) | |
tree | 8548662c60534211b7eb34f2f2881636ec3797b9 /tests/vpp/device/ip4_tunnels/lisp | |
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/ip4_tunnels/lisp')
3 files changed, 51 insertions, 39 deletions
diff --git a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lisp-ip4base-scapy.robot b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lisp-ip4base-scapy.robot index 35343edd18..efaab06a0a 100644 --- a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lisp-ip4base-scapy.robot +++ b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lisp-ip4base-scapy.robot @@ -27,21 +27,25 @@ | | Test Template | Local Template | -| Documentation | *ip4-lisp-ip4 encapsulation test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node\ -| ... | circular topology with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-LISP-IPv4-ICMPv4\ -| ... | on DUT1-TG, Eth-IPv4-ICMPv4 on TG-DUTn for IPv4 routing\ +| Documentation | **ip4-lisp-ip4 encapsulation test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node \ +| ... | circular with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-LISP-IPv4-ICMPv4 \ +| ... | on DUT1-TG, Eth-IPv4-ICMPv4 on TG-DUTn for IPv4 routing \ | ... | over LISPoIPv4 tunnel. -| ... | *[Cfg] DUT configuration:* DUT is configured with IPv4\ -| ... | routing and static routes. LISPoIPv4 tunnel is\ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT is configured with IPv4. \ +| ... | routing and static routes. LISPoIPv4 tunnel is \ | ... | configured between DUT1 and TG2. -| ... | *[Ver] TG verification:* Test ICMPv4 Echo Request packets\ -| ... | are sent by TG on if1 link to DUT1; on receive TG verifies\ -| ... | packets for correctness and their IPv4 src-addr, dst-addr\ +| ... | +| ... | - **[Ver] TG verification:** Test ICMPv4 Echo Request packets \ +| ... | are sent by TG on if1 link to DUT1; on receive TG verifies \ +| ... | packets for correctness and their IPv4 src-addr, dst-addr \ | ... | and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC6830. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC6830. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | lisp_plugin.so @@ -59,7 +63,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure LISP.\ +| | ... | - **[Cfg]** On DUT1 configure LISP. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer diff --git a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip4base-scapy.robot b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip4base-scapy.robot index 6ae9cf4321..80d69476e6 100644 --- a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip4base-scapy.robot +++ b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip4base-scapy.robot @@ -27,21 +27,25 @@ | | Test Template | Local Template | -| Documentation | *ip4-lispgpe-ip4 encapsulation test cases* -| -| ... | *[Top] Network Topologies:* TG-DUT1-TG 2-node\ -| ... | circular topology with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-LISPGPE-IPv4-ICMPv4\ -| ... | on DUT1-TG, Eth-IPv4-ICMPv4 on TG-DUTn for IPv4\ +| Documentation | **ip4-lispgpe-ip4 encapsulation test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG-DUT1-TG 2-node \ +| ... | circular with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-LISPGPE-IPv4-ICMPv4 \ +| ... | on DUT1-TG, Eth-IPv4-ICMPv4 on TG-DUTn for IPv4. \ | ... | routing over LISPoIPv4 tunnel. -| ... | *[Cfg] DUT configuration:* DUT1 and TG(if2) are configured\ -| ... | with IPv4 routing and static routes. LISPoIPv4 tunnel is\ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 and TG(if2) are configured \ +| ... | with IPv4 routing and static routes. LISPoIPv4 tunnel is \ | ... | configured between DUT1 and TG. -| ... | *[Ver] TG verification:* Test ICMPv4 Echo Request packets\ -| ... | are sent in TG->DUT(if1); On receive TG(if2) verifies packets\ -| ... | for correctness and their IPv4 src-addr, dst-addr and\ +| ... | +| ... | - **[Ver] TG verification:** Test ICMPv4 Echo Request packets \ +| ... | are sent in TG->DUT(if1); On receive TG(if2) verifies packets \ +| ... | for correctness and their IPv4 src-addr, dst-addr and \ | ... | MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC6830. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC6830. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | lisp_plugin.so @@ -60,7 +64,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure LISP. +| | ... | - **[Cfg]** On DUT1 configure LISP. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer diff --git a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip6base-scapy.robot b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip6base-scapy.robot index 07ad9da61a..588e00af99 100644 --- a/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip6base-scapy.robot +++ b/tests/vpp/device/ip4_tunnels/lisp/2n1l-10ge2p1x710-ethip4lispgpe-ip6base-scapy.robot @@ -27,21 +27,25 @@ | | Test Template | Local Template | -| Documentation | *ip4-lispgpe-ip6 encapsulation test cases* -| -| ... | *[Top] Network Topologies:* TG(if1)-DUT1-TG(if2) 2-node\ -| ... | circular topology with single links between nodes. -| ... | *[Enc] Packet Encapsulations:* Eth-IPv4-LISPGPE-IPv6-ICMPv6\ -| ... | on DUT1-TG(if2),Eth-IPv6-ICMPv6 on TG-DUTn for IPv6\ +| Documentation | **ip4-lispgpe-ip6 encapsulation test cases** +| ... | +| ... | - **[Top] Network Topologies:** TG(if1)-DUT1-TG(if2) 2-node \ +| ... | circular with single links between nodes. +| ... | +| ... | - **[Enc] Packet Encapsulations:** Eth-IPv4-LISPGPE-IPv6-ICMPv6 \ +| ... | on DUT1-TG(if2),Eth-IPv6-ICMPv6 on TG-DUTn for IPv6 \ | ... | routing over LISPoIPv4 tunnel. -| ... | *[Cfg] DUT configuration:* DUT1 and TG(if2) are configured\ -| ... | with IPv6 routing and static routes. LISPoIPv4 tunnel is\ +| ... | +| ... | - **[Cfg] DUT configuration:** DUT1 and TG(if2) are configured \ +| ... | with IPv6 routing and static routes. LISPoIPv4 tunnel is \ | ... | configured between DUT1 and TG(if2). -| ... | *[Ver] TG verification:* Test ICMPv6 Echo Request packets\ -| ... | are sent in if1 by TG on links to DUT1; on receive\ -| ... | TG verifies packets for correctness and their IPv6 src-addr,\ +| ... | +| ... | - **[Ver] TG verification:** Test ICMPv6 Echo Request packets \ +| ... | are sent in if1 by TG on links to DUT1; on receive \ +| ... | TG verifies packets for correctness and their IPv6 src-addr, \ | ... | dst-addr and MAC addresses. -| ... | *[Ref] Applicable standard specifications:* RFC6830. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC6830. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so | lisp_plugin.so @@ -61,7 +65,7 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure LISPGPE\ +| | ... | - **[Cfg]** On DUT1 configure LISPGPE. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer |