[dpdk-dev] [PATCH] doc: add missing loopback option in testpmd guide

[Iremonger, Bernard]

Hi Rami

> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Rami Rosen
> Sent: Thursday, January 17, 2019 9:31 AM
> To: dev at dpdk.org
> Cc: stable at dpdk.org; Mcnamara, John <john.mcnamara at intel.com>; Rami
> Rosen <ramirose at gmail.com>
> Subject: [dpdk-dev] [PATCH] doc: add missing loopback option in testpmd guide
> 
> This patch adds a missing topology loopback mode for port-topology option in
> testpmd guide. The testpmd loopback option
> (PORT_TOPOLOGY_LOOP)  was added to testpmd parameter port-topology back
> in 2014, but it seems that it was never added to the testpmd guide. This patch
> adds it in the testpmd guide.
> 
> Fixes: 3e2006d6186c ("app/testpmd: add loopback topology")
> Cc: stable at dpdk.org
> Signed-off-by: Rami Rosen <ramirose at gmail.com>
> ---
>  doc/guides/testpmd_app_ug/run_app.rst | 4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst
> b/doc/guides/testpmd_app_ug/run_app.rst
> index f717bd3..ee51b1d 100644
> --- a/doc/guides/testpmd_app_ug/run_app.rst
> +++ b/doc/guides/testpmd_app_ug/run_app.rst
> @@ -196,7 +196,7 @@ The commandline options are:
> 
>  *   ``--port-topology=mode``
> 
> -    Set port topology, where mode is ``paired`` (the default) or ``chained``.
> +    Set port topology, where mode is ``paired`` (the default), ``chained`` or
> ``loopback``.

In the C code (app/test-pmd/parameters.c) "loop" is used instead of "loopback".
The run_app.rst file should use "loop" as well.
 
>      In ``paired`` mode, the forwarding is between pairs of ports, for example:
> (0,1), (2,3), (4,5).
> 
> @@ -204,6 +204,8 @@ The commandline options are:
> 
>      The ordering of the ports can be changed using the portlist testpmd runtime
> function.
> 
> +    In ``loopback`` mode, ingress traffic is simply transmitted back on the same
> interface.
> +
>  *   ``--forward-mode=mode``
> 
>      Set the forwarding mode where ``mode`` is one of the following::
> --
> 1.8.3.1

Regards,

Bernard.