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/crypto | |
| 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/crypto')
6 files changed, 90 insertions, 72 deletions
diff --git a/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec11tnlsw-ip4base-int-aes128cbc-hmac512sha-scapy.robot b/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec11tnlsw-ip4base-int-aes128cbc-hmac512sha-scapy.robot index e150c59c12..d2db9b0ef0 100644 --- a/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec11tnlsw-ip4base-int-aes128cbc-hmac512sha-scapy.robot +++ b/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec11tnlsw-ip4base-int-aes128cbc-hmac512sha-scapy.robot @@ -26,16 +26,19 @@ | | Test Template | Local Template | -| Documentation | *IPv4 IPsec tunnel mode test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **IPv4 IPsec tunnel mode test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 create loopback interface, configure\ -| ... | loopback an physical interface IPv4 addresses, static ARP record, route\ -| ... | and IPsec manual keyed connection in tunnel mode. -| ... | *[Ver] TG verification:* ETH-IP4 packet is sent from TG to DUT1. Packet\ -| ... | is received on TG from DUT1. -| ... | *[Ref] Applicable standard specifications:* RFC4303. +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 create loopback interface, \ +| ... | configure loopback an physical interface IPv4 addresses, static ARP \ +| ... | record, route and IPsec manual keyed connection in tunnel mode. +| ... | +| ... | - **[Ver] TG verification:** ETH-IP4 packet is sent from TG to DUT1. \ +| ... | Packet is received on TG from DUT1. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC4303. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -63,9 +66,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure IPsec tunnel interfaces with encryption\ -| | ... | algorithm AES_128_CBC and integrity algorithm HMAC_SHA_512 in tunnel\ -| | ... | mode. +| | ... | - **[Cfg]** On DUT1 configure IPsec tunnel interfaces with \ +| | ... | encryption algorithm AES_128_CBC and integrity algorithm \ +| | ... | HMAC_SHA_512 in tunnel mode. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer diff --git a/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tnlsw-ip4base-int-aes128cbc-hmac512sha-scapy.robot b/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tnlsw-ip4base-int-aes128cbc-hmac512sha-scapy.robot index 5756fa7185..cf13223b0b 100644 --- a/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tnlsw-ip4base-int-aes128cbc-hmac512sha-scapy.robot +++ b/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tnlsw-ip4base-int-aes128cbc-hmac512sha-scapy.robot @@ -26,16 +26,19 @@ | | Test Template | Local Template | -| Documentation | *IPv4 IPsec tunnel mode test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **IPv4 IPsec tunnel mode test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 create loopback interface, configure\ -| ... | loopback an physical interface IPv4 addresses, static ARP record, route\ -| ... | and IPsec manual keyed connection in tunnel mode. -| ... | *[Ver] TG verification:* ETH-IP4 packet is sent from TG to DUT1. Packet\ -| ... | is received on TG from DUT1. -| ... | *[Ref] Applicable standard specifications:* RFC4303. +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 create loopback interface, \ +| ... | configure loopback an physical interface IPv4 addresses, static ARP \ +| ... | irecord, route and IPsec manual keyed connection in tunnel mode. +| ... | +| ... | - **[Ver] TG verification:** ETH-IP4 packet is sent from TG to DUT1. \ +| ... | Packet is received on TG from DUT1. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC4303. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -63,9 +66,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure IPsec tunnel interface with encryption\ -| | ... | algorithm AES_128_CBC and integrity algorithm HMAC_SHA_512 in tunnel\ -| | ... | mode. +| | ... | - **[Cfg]** On DUT1 configure IPsec tunnel interface with encryption \ +| | ... | algorithm AES_128_CBC and integrity algorithm HMAC_SHA_512 in \ +| | ... | tunnel mode. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer diff --git a/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tnlsw-ip4base-policy-aes128cbc-hmac512sha-scapy.robot b/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tnlsw-ip4base-policy-aes128cbc-hmac512sha-scapy.robot index ca55d02240..b07545e08d 100644 --- a/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tnlsw-ip4base-policy-aes128cbc-hmac512sha-scapy.robot +++ b/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tnlsw-ip4base-policy-aes128cbc-hmac512sha-scapy.robot @@ -26,16 +26,19 @@ | | Test Template | Local Template | -| Documentation | *IPv4 IPsec tunnel mode test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **IPv4 IPsec tunnel mode test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 create loopback interface, configure\ -| ... | loopback an physical interface IPv4 addresses, static ARP record, route\ -| ... | and IPsec manual keyed connection in tunnel mode. -| ... | *[Ver] TG verification:* ESP packet is sent from TG to DUT1. ESP packet\ -| ... | is received on TG from DUT1. -| ... | *[Ref] Applicable standard specifications:* RFC4303. +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 create loopback interface, \ +| ... | configure loopback an physical interface IPv4 addresses, static ARP \ +| ... | record, route and IPsec manual keyed connection in tunnel mode. +| ... | +| ... | - **[Ver] TG verification:** ESP packet is sent from TG to DUT1. ESP \ +| ... | packet is received on TG from DUT1. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC4303. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -64,9 +67,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure IPsec manual keyed connection with encryption\ -| | ... | algorithm AES_128_CBC and integrity algorithm HMAC_SHA_512 in tunnel\ -| | ... | mode. +| | ... | - **[Cfg]** On DUT1 configure IPsec manual keyed connection with \ +| | ... | encryption algorithm AES_128_CBC and integrity algorithm \ +| | ... | HMAC_SHA_512 in tunnel mode. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer diff --git a/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tptsw-ip4base-policy-aes128cbc-hmac512sha-scapy.robot b/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tptsw-ip4base-policy-aes128cbc-hmac512sha-scapy.robot index 234afe597a..84aaa7cd3b 100644 --- a/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tptsw-ip4base-policy-aes128cbc-hmac512sha-scapy.robot +++ b/tests/vpp/device/crypto/ethip4/2n1l-10ge2p1x710-ethip4ipsec1tptsw-ip4base-policy-aes128cbc-hmac512sha-scapy.robot @@ -26,16 +26,19 @@ | | Test Template | Local Template | -| Documentation | *IPv4 IPsec transport mode test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **IPv4 IPsec transport mode test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 create loopback interface, configure\ -| ... | loopback an physical interface IPv4 addresses, static ARP record, route\ -| ... | and IPsec manual keyed connection in transport mode. -| ... | *[Ver] TG verification:* ESP packet is sent from TG to DUT1. ESP packet\ -| ... | is received on TG from DUT1. -| ... | *[Ref] Applicable standard specifications:* RFC4303. +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 create loopback interface, \ +| ... | configure loopback an physical interface IPv4 addresses, static ARP \ +| ... | record, route and IPsec manual keyed connection in transport mode. +| ... | +| ... | - **[Ver] TG verification:** ESP packet is sent from TG to DUT1. ESP \ +| ... | packet is received on TG from DUT1. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC4303. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -64,9 +67,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure IPsec manual keyed connection with encryption\ -| | ... | algorithm AES_128_CBC and integrity algorithm HMAC_SHA_512 in\ -| | ... | transport mode. +| | ... | - **[Cfg]** On DUT1 configure IPsec manual keyed connection with \ +| | ... | encryption algorithm AES_128_CBC and integrity algorithm \ +| | ... | HMAC_SHA_512 in transport mode. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer diff --git a/tests/vpp/device/crypto/ethip6/2n1l-10ge2p1x710-ethip6ipsec1tnlsw-ip6base-policy-aes128cbc-hmac512sha-scapy.robot b/tests/vpp/device/crypto/ethip6/2n1l-10ge2p1x710-ethip6ipsec1tnlsw-ip6base-policy-aes128cbc-hmac512sha-scapy.robot index c8e71996ca..80f557aedd 100644 --- a/tests/vpp/device/crypto/ethip6/2n1l-10ge2p1x710-ethip6ipsec1tnlsw-ip6base-policy-aes128cbc-hmac512sha-scapy.robot +++ b/tests/vpp/device/crypto/ethip6/2n1l-10ge2p1x710-ethip6ipsec1tnlsw-ip6base-policy-aes128cbc-hmac512sha-scapy.robot @@ -26,16 +26,19 @@ | | Test Template | Local Template | -| Documentation | *IPv6 IPsec tunnel mode test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **IPv6 IPsec tunnel mode test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 create loopback interface, configure -| ... | loopback an physical interface IPv6 addresses, static ARP record, route -| ... | and IPsec manual keyed connection in tunnel mode. -| ... | *[Ver] TG verification:* ESP packet is sent from TG to DUT1. ESP packet -| ... | is received on TG from DUT1. -| ... | *[Ref] Applicable standard specifications:* RFC4303. +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 create loopback interface, \ +| ... | configure loopback an physical interface IPv6 addresses, static ARP \ +| ... | record, route and IPsec manual keyed connection in tunnel mode. +| ... | +| ... | - **[Ver] TG verification:** ESP packet is sent from TG to DUT1. ESP \ +| ... | packet is received on TG from DUT1. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC4303. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -65,9 +68,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure IPsec manual keyed connection with encryption\ -| | ... | algorithm AES_128_CBC and integrity algorithm HMAC_SHA_512 in tunnel\ -| | ... | mode. +| | ... | - **[Cfg]** On DUT1 configure IPsec manual keyed connection with \ +| | ... | encryption algorithm AES_128_CBC and integrity algorithm \ +| | ... | HMAC_SHA_512 in tunnel mode. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer diff --git a/tests/vpp/device/crypto/ethip6/2n1l-10ge2p1x710-ethip6ipsec1tptsw-ip6base-policy-aes128cbc-hmac512sha-scapy.robot b/tests/vpp/device/crypto/ethip6/2n1l-10ge2p1x710-ethip6ipsec1tptsw-ip6base-policy-aes128cbc-hmac512sha-scapy.robot index 35fb82e91d..e195212db4 100644 --- a/tests/vpp/device/crypto/ethip6/2n1l-10ge2p1x710-ethip6ipsec1tptsw-ip6base-policy-aes128cbc-hmac512sha-scapy.robot +++ b/tests/vpp/device/crypto/ethip6/2n1l-10ge2p1x710-ethip6ipsec1tptsw-ip6base-policy-aes128cbc-hmac512sha-scapy.robot @@ -26,16 +26,19 @@ | | Test Template | Local Template | -| Documentation | *IPv6 IPsec transport mode test suite.* -| -| ... | *[Top] Network topologies:* TG-DUT1 2-node topology with one link\ +| Documentation | **IPv6 IPsec transport mode test suite.** +| ... | +| ... | - **[Top] Network topologies:** TG-DUT1 2-node topology with one link \ | ... | between nodes. -| ... | *[Cfg] DUT configuration:* On DUT1 create loopback interface, configure -| ... | loopback an physical interface IPv6 addresses, static ARP record, route -| ... | and IPsec manual keyed connection in transport mode. -| ... | *[Ver] TG verification:* ESP packet is sent from TG to DUT1. ESP packet -| ... | is received on TG from DUT1. -| ... | *[Ref] Applicable standard specifications:* RFC4303. +| ... | +| ... | - **[Cfg] DUT configuration:** On DUT1 create loopback interface, \ +| ... | configure loopback an physical interface IPv6 addresses, static ARP \ +| ... | record, route and IPsec manual keyed connection in transport mode. +| ... | +| ... | - **[Ver] TG verification:** ESP packet is sent from TG to DUT1. ESP \ +| ... | packet is received on TG from DUT1. +| ... | +| ... | - **[Ref] Applicable standard specifications:** RFC4303. *** Variables *** | @{plugins_to_enable}= | dpdk_plugin.so | perfmon_plugin.so @@ -65,9 +68,9 @@ *** Keywords *** | Local Template | | [Documentation] -| | ... | [Cfg] On DUT1 configure IPsec manual keyed connection with encryption\ -| | ... | algorithm AES_128_CBC and integrity algorithm HMAC_SHA_512 in\ -| | ... | transport mode. +| | ... | - **[Cfg]** On DUT1 configure IPsec manual keyed connection with \ +| | ... | encryption algorithm AES_128_CBC and integrity algorithm \ +| | ... | HMAC_SHA_512 in transport mode. | | | | ... | *Arguments:* | | ... | - frame_size - Framesize in Bytes in integer. Type: integer |