This patch updates documentation for testpmd.
Signed-off-by: Zhihong Wang <zhihong.wang at intel.com>
---
doc/guides/testpmd_app_ug/run_app.rst | 1 +
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 10 +++++++---
2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/doc/guides/testpmd_app_ug/run_app.rst
b/doc/guides/testpmd_app_ug/run_app.rst
index f605564..edd3e42 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -328,6 +328,7 @@ The commandline options are:
Set the forwarding mode where ``mode`` is one of the following::
io (the default)
+ io_retry
mac
mac_retry
mac_swap
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index aed5e47..7703c89 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -98,9 +98,11 @@ Start packet forwarding with current configuration::
start tx_first
~~~~~~~~~~~~~~
-Start packet forwarding with current configuration after sending one burst of
packets::
+Start packet forwarding with current configuration after sending specified
number of bursts of packets::
- testpmd> start tx_first
+ testpmd> start tx_first (""|burst_num)
+
+The default burst number is 1 when ``burst_num`` not presented.
stop
~~~~
@@ -249,7 +251,7 @@ set fwd
Set the packet forwarding mode::
- testpmd> set fwd (io|mac|mac_retry|macswap|flowgen| \
+ testpmd> set fwd (io|io_retry|mac|mac_retry|macswap|flowgen| \
rxonly|txonly|csum|icmpecho)
The available information categories are:
@@ -258,6 +260,8 @@ The available information categories are:
This is the fastest possible forwarding operation as it does not access
packets data.
This is the default mode.
+* ``io_retry``: Forwards packets "as-is" in I/O retry mode.
+
* ``mac``: Changes the source and the destination Ethernet addresses of
packets before forwarding them.
* ``mac_retry``: Same as "mac" forwarding mode, but includes retries if the
destination queue is full.
--
2.5.0
