[V2] doc: add missing loopback option in testpmd guide

Message ID 1547725166-15070-1-git-send-email-ramirose@gmail.com
State Accepted, archived
Delegated to: Ferruh Yigit
Headers show
Series
  • [V2] doc: add missing loopback option in testpmd guide
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Rami Rosen Jan. 17, 2019, 11:39 a.m.
This patch adds a missing topology "loop" mode for port-topology
option in testpmd guide. The testpmd "loop" 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.

v2: Change "loopback" to "loop" (following Bernard review)

Fixes: 3e2006d6186c ("app/testpmd: add loopback topology")
Cc: stable@dpdk.org
Signed-off-by: Rami Rosen <ramirose@gmail.com>
---
 doc/guides/testpmd_app_ug/run_app.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Iremonger, Bernard Jan. 17, 2019, 1:24 p.m. | #1
> -----Original Message-----
> From: Rami Rosen [mailto:ramirose@gmail.com]
> Sent: Thursday, January 17, 2019 11:39 AM
> To: dev@dpdk.org
> Cc: stable@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>;
> Iremonger, Bernard <bernard.iremonger@intel.com>; Rami Rosen
> <ramirose@gmail.com>
> Subject: [PATCH V2] doc: add missing loopback option in testpmd guide
> 
> This patch adds a missing topology "loop" mode for port-topology option in
> testpmd guide. The testpmd "loop" 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.
> 
> v2: Change "loopback" to "loop" (following Bernard review)
> 
> Fixes: 3e2006d6186c ("app/testpmd: add loopback topology")
> Cc: stable@dpdk.org
> Signed-off-by: Rami Rosen <ramirose@gmail.com>

Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>
Ferruh Yigit Jan. 17, 2019, 4:55 p.m. | #2
On 1/17/2019 1:24 PM, Iremonger, Bernard wrote:
>> -----Original Message-----
>> From: Rami Rosen [mailto:ramirose@gmail.com]
>> Sent: Thursday, January 17, 2019 11:39 AM
>> To: dev@dpdk.org
>> Cc: stable@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>;
>> Iremonger, Bernard <bernard.iremonger@intel.com>; Rami Rosen
>> <ramirose@gmail.com>
>> Subject: [PATCH V2] doc: add missing loopback option in testpmd guide
>>
>> This patch adds a missing topology "loop" mode for port-topology option in
>> testpmd guide. The testpmd "loop" 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.
>>
>> v2: Change "loopback" to "loop" (following Bernard review)
>>
>> Fixes: 3e2006d6186c ("app/testpmd: add loopback topology")
>> Cc: stable@dpdk.org
>> Signed-off-by: Rami Rosen <ramirose@gmail.com>
> 
> Acked-by: Bernard Iremonger <bernard.iremonger@intel.com>

Applied to dpdk-next-net/master, thanks.

Patch

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 ``loop``.
 
     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 ``loop`` 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::