Update documentation to include description of
'record-core-cycles' 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 | 6 ++++++
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 15 +++++++++++++++
2 files changed, 21 insertions(+)
diff --git a/doc/guides/testpmd_app_ug/run_app.rst
b/doc/guides/testpmd_app_ug/run_app.rst
index d1e4ee3e7a46..2b8e0ad69157 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -489,3 +489,9 @@ The command line options are:
The default value is 0x7::
ETH_MQ_RX_RSS_FLAG | ETH_MQ_RX_DCB_FLAG | ETH_MQ_RX_VMDQ_FLAG
+
+* ``--record-core-cycles``
+
+ Enable measurement of CPU cycles per packet.
+
+
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index f8cfb02e38ab..980bf3340763 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -710,6 +710,21 @@ Set the forwarding ports hexadecimal mask::
This is equivalent to the ``--portmask`` command-line option.
+set record-core-cycles
+~~~~~~~~~~~~~~~~~~~~~~
+
+Set the recording of CPU cycles::
+
+ testpmd> set record-core-cycles (on|off)
+
+Where:
+
+* ``on`` enables measurement of CPU cycles per packet.
+
+* ``off`` disables measurement of CPU cycles per packet.
+
+This is equivalent to the ``--record-core-cycles command-line`` option.
+
set burst
~~~~~~~~~
--
2.17.1
