Update documentation to include description of
'record-burst-stats' runtime configuration.
Signed-off-by: Dharmik Thakkar <dharmik.thak...@arm.com>
Reviewed-by: Phil Yang <phil.y...@arm.com>
Reviewed-by: Ruifeng Wang <ruifeng.w...@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagaraha...@arm.com>
---
doc/guides/testpmd_app_ug/run_app.rst | 2 ++
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 15 +++++++++++++++
2 files changed, 17 insertions(+)
diff --git a/doc/guides/testpmd_app_ug/run_app.rst
b/doc/guides/testpmd_app_ug/run_app.rst
index 2b8e0ad69157..e2539f693f66 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -494,4 +494,6 @@ The command line options are:
Enable measurement of CPU cycles per packet.
+* ``--record-burst-stats``
+ Enable display of RX and TX burst stats.
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 980bf3340763..2192a7e4720d 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -725,6 +725,21 @@ Where:
This is equivalent to the ``--record-core-cycles command-line`` option.
+set record-burst-stats
+~~~~~~~~~~~~~~~~~~~~~~
+
+Set the displaying of RX and TX bursts::
+
+ testpmd> set record-burst-stats (on|off)
+
+Where:
+
+* ``on`` enables display of RX and TX bursts.
+
+* ``off`` disables display of RX and TX bursts.
+
+This is equivalent to the ``--record-burst-stats command-line`` option.
+
set burst
~~~~~~~~~
--
2.17.1
