Patchwork [dpdk-dev] doc: remove redundant "OF" prefix from testpmd doc

login
register
mail settings
Submitter Dekel Peled
Date Dec. 6, 2018, 12:06 p.m.
Message ID <1544097974-5507-1-git-send-email-dekelp@mellanox.com>
Download mbox | patch
Permalink /patch/673985/
State New
Headers show

Comments

Dekel Peled - Dec. 6, 2018, 12:06 p.m.
testpmd actions set_tp_src and set_tp_dst documentation adds the
of_ prefix to action names, while the implementation doesn't add it.

This patch removes the prefix from action names in testpmd
documentation.

Fixes: 9ccc94919500 ("ethdev: add flow API actions to modify TCP/UDP port numbers")
Cc: rahul.lakkireddy@chelsio.com

Signed-off-by: Dekel Peled <dekelp@mellanox.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Ori Kam - Dec. 6, 2018, 12:15 p.m.
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Dekel Peled
> Sent: Thursday, December 6, 2018 2:06 PM
> To: wenzhuo.lu@intel.com; jingjing.wu@intel.com;
> bernard.iremonger@intel.com
> Cc: dev@dpdk.org; Ori Kam <orika@mellanox.com>; Shahaf Shuler
> <shahafs@mellanox.com>; Dekel Peled <dekelp@mellanox.com>;
> rahul.lakkireddy@chelsio.com
> Subject: [dpdk-dev] [PATCH] doc: remove redundant "OF" prefix from testpmd
> doc
> 
> testpmd actions set_tp_src and set_tp_dst documentation adds the
> of_ prefix to action names, while the implementation doesn't add it.
> 
> This patch removes the prefix from action names in testpmd
> documentation.
> 
> Fixes: 9ccc94919500 ("ethdev: add flow API actions to modify TCP/UDP port
> numbers")
> Cc: rahul.lakkireddy@chelsio.com
> 
> Signed-off-by: Dekel Peled <dekelp@mellanox.com>
> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index 056f8bb..9d4f107 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -3931,12 +3931,12 @@ This section lists supported actions and their
> attributes, if any.
> 
>    - ``ipv6_addr``: New IPv6 destination address.
> 
> -- ``of_set_tp_src``: Set a new source port number in the outermost TCP/UDP
> +- ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
>    header.
> 
>    - ``port``: New TCP/UDP source port number.
> 
> -- ``of_set_tp_dst``: Set a new destination port number in the outermost
> TCP/UDP
> +- ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
>    header.
> 
>    - ``port``: New TCP/UDP destination port number.
> --
> 1.8.3.1

Acked-by: Ori Kam <orika@mellanox.com>
Thanks,
Ori
Rahul Lakkireddy - Dec. 6, 2018, 12:18 p.m.
On Thursday, December 12/06/18, 2018 at 17:36:14 +0530, Dekel Peled wrote:
> testpmd actions set_tp_src and set_tp_dst documentation adds the
> of_ prefix to action names, while the implementation doesn't add it.
> 
> This patch removes the prefix from action names in testpmd
> documentation.
> 
> Fixes: 9ccc94919500 ("ethdev: add flow API actions to modify TCP/UDP port numbers")
> Cc: rahul.lakkireddy@chelsio.com
> 
> Signed-off-by: Dekel Peled <dekelp@mellanox.com>
> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index 056f8bb..9d4f107 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -3931,12 +3931,12 @@ This section lists supported actions and their attributes, if any.
>  
>    - ``ipv6_addr``: New IPv6 destination address.
>  
> -- ``of_set_tp_src``: Set a new source port number in the outermost TCP/UDP
> +- ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
>    header.
>  
>    - ``port``: New TCP/UDP source port number.
>  
> -- ``of_set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
> +- ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
>    header.
>  
>    - ``port``: New TCP/UDP destination port number.
> -- 
> 1.8.3.1
> 

Good catch!

Acked-by: Rahul Lakkireddy <rahul.lakkireddy@chelsio.com>

Patch

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 056f8bb..9d4f107 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -3931,12 +3931,12 @@  This section lists supported actions and their attributes, if any.
 
   - ``ipv6_addr``: New IPv6 destination address.
 
-- ``of_set_tp_src``: Set a new source port number in the outermost TCP/UDP
+- ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
   header.
 
   - ``port``: New TCP/UDP source port number.
 
-- ``of_set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
+- ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
   header.
 
   - ``port``: New TCP/UDP destination port number.