[4/6] doc: add record-burst-stats to testpmd funcs doc
Checks
Commit Message
Update documentation to include description of
'record-burst-stats' runtime configuration.
Signed-off-by: Dharmik Thakkar <dharmik.thakkar@arm.com>
Reviewed-by: Phil Yang <phil.yang@arm.com>
Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagarahalli@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(+)
@@ -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.
@@ -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
~~~~~~~~~