From d0ea764a5d7370747ca3dbb1288c62ee5ccba67c Mon Sep 17 00:00:00 2001 From: Nathan Skrzypczak Date: Wed, 29 Sep 2021 15:37:34 +0200 Subject: docs: plugin comment nitfixes Type: improvement Change-Id: Ib7e2f5f314144064de7b6be0fade3db2f9c943fe Signed-off-by: Nathan Skrzypczak --- src/plugins/cnat/cnat.rst | 14 +++++++------- src/plugins/geneve/geneve.c | 24 ++++++++++++------------ src/plugins/gtpu/gtpu.c | 17 ++++++++++------- src/plugins/lacp/node.c | 2 +- src/plugins/lb/lb.h | 2 +- src/plugins/map/map.c | 5 ++--- src/plugins/mdata/mdata.c | 16 ++++++++-------- src/plugins/pppoe/pppoe.c | 8 ++++---- src/plugins/svs/svs_api.c | 6 ++---- src/plugins/unittest/mfib_test.c | 2 +- src/plugins/urpf/urpf.c | 8 ++++---- 11 files changed, 52 insertions(+), 52 deletions(-) (limited to 'src') diff --git a/src/plugins/cnat/cnat.rst b/src/plugins/cnat/cnat.rst index 8781f405a23..cdb751416db 100644 --- a/src/plugins/cnat/cnat.rst +++ b/src/plugins/cnat/cnat.rst @@ -9,7 +9,7 @@ Overview ________ This plugin covers specific NAT use-cases that come mostly -from the container networking world. On the contraty of the +from the container networking world. On the contrary of the NAT concepts used for e.g. a home gateway, there is no notion of 'outside' and 'inside'. We handle Virtual (or Real) IPs and translations of the packets destined to them @@ -33,9 +33,9 @@ that will store the packet rewrite to do and the one to undo until the flow is reset or a timeout is reached A ``session`` is a fully resolved 9-tuple of ``src_ip, src_port, dest_ip, dest_port, proto`` -to match incoming packets, and their new attributes ``new_src_ip, new_src_port, new_dest_ip, new_dest_port``. It allows for ``backend`` stickyness and a fast-path for established connections. +to match incoming packets, and their new attributes ``new_src_ip, new_src_port, new_dest_ip, new_dest_port``. It allows for ``backend`` stickiness and a fast-path for established connections. -These ``sessions`` expire after 30s for regular ``sessions`` and 1h for estabished +These ``sessions`` expire after 30s for regular ``sessions`` and 1h for established TCP connections. These can be changed in vpp's configuration file .. code-block:: console @@ -64,7 +64,7 @@ assigned to an interface If ``30.0.0.2`` is the address of an interface, we can use the following -to do the same translation, and additionnaly change the source. +to do the same translation, and additionally change the source. address with ``1.2.3.4`` .. code-block:: console @@ -82,10 +82,10 @@ To show existing translations and sessions you can use SourceNATing outgoing traffic ----------------------------- -A independant part of the plugin allows changing the source address +A independent part of the plugin allows changing the source address of outgoing traffic on a per-interface basis. -In the following example, all traffic comming from ``tap0`` and NOT +In the following example, all traffic coming from ``tap0`` and NOT going to ``20.0.0.0/24`` will be source NAT-ed with ``30.0.0.1``. On the way back the translation will be undone. @@ -133,7 +133,7 @@ and call a NAT node back that will perform the translation. Known limitations _________________ -This plugin is still under developpment, it lacks the following features : +This plugin is still under development, it lacks the following features : * Load balancing doesn't support parametric probabilities * VRFs aren't supported. All rules apply to fib table 0 only * Programmatic session handling (deletion, lifetime updates) aren't supported diff --git a/src/plugins/geneve/geneve.c b/src/plugins/geneve/geneve.c index 62502ef3fde..5bd612257a5 100644 --- a/src/plugins/geneve/geneve.c +++ b/src/plugins/geneve/geneve.c @@ -995,7 +995,7 @@ set_ip4_geneve_bypass (vlib_main_t * vm, /*? * This command adds the 'ip4-geneve-bypass' graph node for a given interface. * By adding the IPv4 geneve-bypass graph node to an interface, the node checks - * for and validate input geneve packet and bypass ip4-lookup, ip4-local, + * for and validate input geneve packet and bypass ip4-lookup, ip4-local, * ip4-udp-lookup nodes to speedup geneve packet forwarding. This node will * cause extra overhead to for non-geneve packets which is kept at a minimum. * @@ -1014,13 +1014,13 @@ set_ip4_geneve_bypass (vlib_main_t * vm, * * Example of graph node after ip4-geneve-bypass is enabled: * @cliexstart{show vlib graph ip4-geneve-bypass} - * Name Next Previous - * ip4-geneve-bypass error-drop [0] ip4-input - * geneve4-input [1] ip4-input-no-checksum - * ip4-lookup [2] + * Name Next Previous + * ip4-geneve-bypass error-drop [0] ip4-input + * geneve4-input [1] ip4-input-no-checksum + * ip4-lookup [2] * @cliexend * - * Example of how to display the feature enabed on an interface: + * Example of how to display the feature enabled on an interface: * @cliexstart{show ip interface features GigabitEthernet2/0/0} * IP feature paths configured on GigabitEthernet2/0/0... * ... @@ -1052,7 +1052,7 @@ set_ip6_geneve_bypass (vlib_main_t * vm, /*? * This command adds the 'ip6-geneve-bypass' graph node for a given interface. * By adding the IPv6 geneve-bypass graph node to an interface, the node checks - * for and validate input geneve packet and bypass ip6-lookup, ip6-local, + * for and validate input geneve packet and bypass ip6-lookup, ip6-local, * ip6-udp-lookup nodes to speedup geneve packet forwarding. This node will * cause extra overhead to for non-geneve packets which is kept at a minimum. * @@ -1071,13 +1071,13 @@ set_ip6_geneve_bypass (vlib_main_t * vm, * * Example of graph node after ip6-geneve-bypass is enabled: * @cliexstart{show vlib graph ip6-geneve-bypass} - * Name Next Previous - * ip6-geneve-bypass error-drop [0] ip6-input - * geneve6-input [1] ip4-input-no-checksum - * ip6-lookup [2] + * Name Next Previous + * ip6-geneve-bypass error-drop [0] ip6-input + * geneve6-input [1] ip4-input-no-checksum + * ip6-lookup [2] * @cliexend * - * Example of how to display the feature enabed on an interface: + * Example of how to display the feature enabled on an interface: * @cliexstart{show ip interface features GigabitEthernet2/0/0} * IP feature paths configured on GigabitEthernet2/0/0... * ... diff --git a/src/plugins/gtpu/gtpu.c b/src/plugins/gtpu/gtpu.c index 531e45a1d5a..960454adf13 100644 --- a/src/plugins/gtpu/gtpu.c +++ b/src/plugins/gtpu/gtpu.c @@ -879,17 +879,20 @@ done: * to span multiple servers. This is done by building an L2 overlay on * top of an L3 network underlay using GTPU tunnels. * - * GTPU can also be used to transport IP packetes as its PDU type to + * GTPU can also be used to transport IP packets as its PDU type to * allow IP forwarding over underlay network, e.g. between RAN and UPF - * for mobility deplyments. + * for mobility deployments. * * @cliexpar * Example of how to create a GTPU Tunnel: - * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 tteid 55 encap-vrf-id 7} + * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 tteid 55 + * encap-vrf-id 7} * Example of how to delete a GTPU Tunnel: - * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 encap-vrf-id 7 del} + * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 teid 13 encap-vrf-id + * 7 del} * Example of how to update tx TEID of a GTPU Tunnel: - * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 encap-vrf-id 7 upd-tteid 55} + * @cliexcmd{create gtpu tunnel src 10.0.3.1 dst 10.0.3.3 encap-vrf-id 7 + * upd-tteid 55} ?*/ /* *INDENT-OFF* */ VLIB_CLI_COMMAND (create_gtpu_tunnel_command, static) = { @@ -1004,7 +1007,7 @@ set_ip4_gtpu_bypass (vlib_main_t * vm, /*? * This command adds the 'ip4-gtpu-bypass' graph node for a given interface. * By adding the IPv4 gtpu-bypass graph node to an interface, the node checks - * for and validate input gtpu packet and bypass ip4-lookup, ip4-local, + * for and validate input gtpu packet and bypass ip4-lookup, ip4-local, * ip4-udp-lookup nodes to speedup gtpu packet forwarding. This node will * cause extra overhead to for non-gtpu packets which is kept at a minimum. * @@ -1061,7 +1064,7 @@ set_ip6_gtpu_bypass (vlib_main_t * vm, /*? * This command adds the 'ip6-gtpu-bypass' graph node for a given interface. * By adding the IPv6 gtpu-bypass graph node to an interface, the node checks - * for and validate input gtpu packet and bypass ip6-lookup, ip6-local, + * for and validate input gtpu packet and bypass ip6-lookup, ip6-local, * ip6-udp-lookup nodes to speedup gtpu packet forwarding. This node will * cause extra overhead to for non-gtpu packets which is kept at a minimum. * diff --git a/src/plugins/lacp/node.c b/src/plugins/lacp/node.c index 4f78880c741..f70ea69deef 100644 --- a/src/plugins/lacp/node.c +++ b/src/plugins/lacp/node.c @@ -33,7 +33,7 @@ lacp_state_struct lacp_state_array[] = { The interior node is neither pipelined nor dual-looped, because it would be very unusual to see more than one LACP packet in - a given input frame. So, it's a very simple / straighforward + a given input frame. So, it's a very simple / straightforward example. */ diff --git a/src/plugins/lb/lb.h b/src/plugins/lb/lb.h index ebbb1f6f8f0..4618015071e 100644 --- a/src/plugins/lb/lb.h +++ b/src/plugins/lb/lb.h @@ -22,7 +22,7 @@ * The load-balancer receives traffic destined to VIP (Virtual IP) * addresses from one or multiple(ECMP) routers. * The load-balancer tunnels the traffic toward many application servers - * ensuring session stickyness (i.e. that a single sessions is tunneled + * ensuring session stickiness (i.e. that a single sessions is tunneled * towards a single application server). * */ diff --git a/src/plugins/map/map.c b/src/plugins/map/map.c index 938793c8947..7ae14828d20 100644 --- a/src/plugins/map/map.c +++ b/src/plugins/map/map.c @@ -1312,7 +1312,7 @@ VLIB_CLI_COMMAND(map_pre_resolve_command, static) = { /*? * Enable or disable the MAP-E inbound security check - * Specifiy if the inbound security check should be done on fragments + * Specify if the inbound security check should be done on fragments * * @cliexpar * @cliexstart{map params security-check} @@ -1333,9 +1333,8 @@ VLIB_CLI_COMMAND(map_security_check_command, static) = { .function = map_security_check_command_fn, }; - /*? - * Specifiy the IPv4 source address used for relayed ICMP error messages + * Specify the IPv4 source address used for relayed ICMP error messages * * @cliexpar * @cliexstart{map params icmp source-address} diff --git a/src/plugins/mdata/mdata.c b/src/plugins/mdata/mdata.c index 69622960c39..ba8f85f5177 100644 --- a/src/plugins/mdata/mdata.c +++ b/src/plugins/mdata/mdata.c @@ -203,15 +203,15 @@ mdata_enable_disable_command_fn (vlib_main_t * vm, /*? * This command enables or disables buffer metadata change tracking * - *@cliexpar + * @cliexpar * To enable buffer metadata change tracking: - *@cliexstart{buffer metadata tracking on} + * @cliexstart{buffer metadata tracking on} * Tracking enabled - *@cliexend + * @cliexend * - *@cliexstart{buffer metadata tracking off} + * @cliexstart{buffer metadata tracking off} * Tracking disabled - *@cliexend + * @cliexend ?*/ /* *INDENT-OFF* */ @@ -472,13 +472,13 @@ show_metadata_command_fn (vlib_main_t * vm, /*? * This command displays buffer metadata change information - *@cliexpar + * @cliexpar * How to display buffer metadata change information - *@cliexstart{show buffer metadata} + * @cliexstart{show buffer metadata} * ethernet-input: current_data current_length flags error * vnet_buffer_t: l2_hdr_offset l3_hdr_offset * vnet_buffer2_t: no changes - *@cliexend + * @cliexend ?*/ /* *INDENT-OFF* */ diff --git a/src/plugins/pppoe/pppoe.c b/src/plugins/pppoe/pppoe.c index 1589725eddd..d073a941cba 100644 --- a/src/plugins/pppoe/pppoe.c +++ b/src/plugins/pppoe/pppoe.c @@ -721,7 +721,7 @@ show_pppoe_fib_command_fn (vlib_main_t * vm, } /*? - * This command dispays the MAC Address entries of the PPPoE FIB table. + * This command displays the MAC Address entries of the PPPoE FIB table. * Output can be filtered to just get the number of MAC Addresses or display * each MAC Address. * @@ -729,9 +729,9 @@ show_pppoe_fib_command_fn (vlib_main_t * vm, * Example of how to display the number of MAC Address entries in the PPPoE * FIB table: * @cliexstart{show pppoe fib} - * Mac Address session_id Interface sw_if_index session_index - * 52:54:00:53:18:33 1 GigabitEthernet0/8/0 2 0 - * 52:54:00:53:18:55 2 GigabitEthernet0/8/1 3 1 + * Mac Address session_id Interface sw_if_index session_index + * 52:54:00:53:18:33 1 GigabitEthernet0/8/0 2 0 + * 52:54:00:53:18:55 2 GigabitEthernet0/8/1 3 1 * @cliexend ?*/ /* *INDENT-OFF* */ diff --git a/src/plugins/svs/svs_api.c b/src/plugins/svs/svs_api.c index 628acd01b01..7c0850738f3 100644 --- a/src/plugins/svs/svs_api.c +++ b/src/plugins/svs/svs_api.c @@ -191,12 +191,10 @@ svs_api_init (vlib_main_t * vm) VLIB_INIT_FUNCTION (svs_api_init); -/* *INDENT-OFF* */ VLIB_PLUGIN_REGISTER () = { - .version = VPP_BUILD_VER, - .description = "Source Virtual Routing and Fowarding (VRF) Select", + .version = VPP_BUILD_VER, + .description = "Source Virtual Routing and Forwarding (VRF) Select", }; -/* *INDENT-ON* */ /* * fd.io coding-style-patch-verification: ON diff --git a/src/plugins/unittest/mfib_test.c b/src/plugins/unittest/mfib_test.c index 373ea485969..73abd07e80c 100644 --- a/src/plugins/unittest/mfib_test.c +++ b/src/plugins/unittest/mfib_test.c @@ -816,7 +816,7 @@ mfib_test_i (fib_protocol_t PROTO, /* MFIB_TEST_NS(!mfib_test_entry_no_itf(mfei, tm->hw[3]->sw_if_index)); */ /* - * remove the last path and the accpeting only interface, + * remove the last path and the accepting only interface, * the entry still has flags so it remains */ vec_reset_length(two_paths); diff --git a/src/plugins/urpf/urpf.c b/src/plugins/urpf/urpf.c index 7e1986a4250..6cf7cda8744 100644 --- a/src/plugins/urpf/urpf.c +++ b/src/plugins/urpf/urpf.c @@ -196,12 +196,12 @@ done: * * Example of graph node after range checking is enabled: * @cliexstart{show vlib graph ip4-rx-urpf-loose} - * Name Next Previous - * ip4-rx-urpf-loose ip4-drop [0] ip4-input-no-checksum - * ip4-source-and-port-range- ip4-input + * Name Next Previous + * ip4-rx-urpf-loose ip4-drop [0] ip4-input-no-checksum + * ip4-source-and-port-range- ip4-input * @cliexend * - * Example of how to display the feature enabed on an interface: + * Example of how to display the feature enabled on an interface: * @cliexstart{show ip interface features GigabitEthernet2/0/0} * IP feature paths configured on GigabitEthernet2/0/0... * -- cgit 1.2.3-korg