Update testpmd documentation to include RECORD configuration options,
CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES and
CONFIG_RTE_TEST_PMD_RECORD_BURST_STATS.
Signed-off-by: Dharmik Thakkar <dharmik.thak...@arm.com>
Reviewed-by: Honnappa Nagarahalli <honnappa.nagaraha...@arm.com>
Reviewed-by: Phil Yang <phil.y...@arm.com>
---
v2:
- Remove extra '#'.
---
doc/guides/testpmd_app_ug/build_app.rst | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/doc/guides/testpmd_app_ug/build_app.rst
b/doc/guides/testpmd_app_ug/build_app.rst
index d1ca9f3d19a9..b93c82b8c115 100644
--- a/doc/guides/testpmd_app_ug/build_app.rst
+++ b/doc/guides/testpmd_app_ug/build_app.rst
@@ -21,6 +21,18 @@ The basic compilation steps are:
export RTE_TARGET=x86_64-native-linux-gcc
+#. If required, enable configuration options. For example:
+
+ .. code-block:: console
+
+ cd to the top-level DPDK directory
+ sed -i 's,\(CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES\)=n,\1=y,'
config/common_base
+ sed -i 's,\(CONFIG_RTE_TEST_PMD_RECORD_BURST_STATS\)=n,\1=y,'
config/common_base
+
+ Enabling CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES enables measurement of CPU
cycles.
+
+ Enabling CONFIG_RTE_TEST_PMD_RECORD_BURST_STATS enables display of RX and
TX bursts.
+
#. Build the application:
.. code-block:: console
--
2.20.1
