[dpdk-dev] [PATCH] doc: fix a parameter name in testpmd guide

[dpdk-dev] [PATCH] doc: fix a parameter name in testpmd guide

[Rami Rosen]

There is no parameter called "eth-peer-configfile" in testpmd. It should be 
"eth-peers-configfile". See the usage() method in app/test-pmd/parameters.c.

Fixes: a67857e97ba8 ("doc: clarify usage of testpmd MAC forward mode")
Cc: stable@dpdk.org

Signed-off-by: Rami Rosen <ramirose@gmail.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index cbf23e9..1ceb000 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -304,7 +304,7 @@ The available information categories are:
 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
   Default application behaviour is to set source Ethernet address to that of the transmitting interface, and destination
   address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
-  'eth-peer-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
+  'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
 
 * ``macswap``: MAC swap forwarding mode.
   Swaps the source and the destination Ethernet addresses of packets before forwarding them.
-- 
1.8.3.1

Re: [dpdk-dev] [PATCH] doc: fix a parameter name in testpmd guide

[Iremonger, Bernard]

Hi Rami,

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Rami Rosen
> Sent: Tuesday, December 25, 2018 1:37 PM
> To: dev@dpdk.org
> Cc: stable@dpdk.org; Rami Rosen <ramirose@gmail.com>
> Subject: [dpdk-dev] [PATCH] doc: fix a parameter name in testpmd guide
> 
> There is no parameter called "eth-peer-configfile" in testpmd. It should be
> "eth-peers-configfile". See the usage() method in app/test-
> pmd/parameters.c.
> 
> Fixes: a67857e97ba8 ("doc: clarify usage of testpmd MAC forward mode")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Rami Rosen <ramirose@gmail.com>
> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index cbf23e9..1ceb000 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -304,7 +304,7 @@ The available information categories are:
>  * ``mac``: Changes the source and the destination Ethernet addresses of
> packets before forwarding them.
>    Default application behaviour is to set source Ethernet address to that of
> the transmitting interface, and destination
>    address to a dummy value (set during init). The user may specify a target
> destination Ethernet address via the 'eth-peer' or
> -  'eth-peer-configfile' command-line options. It is not currently possible to
> specify a specific source Ethernet address.
> +  'eth-peers-configfile' command-line options. It is not currently possible to
> specify a specific source Ethernet address.
> 
>  * ``macswap``: MAC swap forwarding mode.
>    Swaps the source and the destination Ethernet addresses of packets
> before forwarding them.
> --
> 1.8.3.1

./dpdk/devtools/check-git-log.sh -1
Line too long:
        "eth-peers-configfile". See the usage() method in app/test-pmd/parameters.c.

./dpdk/devtools/checkpatches.sh /home/bairemon/patches_19_02_rc1_patchwork_testpmd/doc-fix-a-parameter-name-in-testpmd-guide.patch

### doc: fix a parameter name in testpmd guide

WARNING:COMMIT_LOG_LONG_LINE: Possible unwrapped commit description (prefer a maximum 75 chars per line)
#18: 
There is no parameter called "eth-peer-configfile" in testpmd. It should be 

total: 0 errors, 1 warnings, 8 lines checked

The above warnings should be fixed.

Regards,

Bernard.