Update documentation for 'show fwd' testpmd runtime function to show
CPU cycles/packet example.
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>
---
v3:
- Keep existing stats and add a note providing CPU cycles/packet
example (Ferruh)
- Remove platform specific information (Ferruh)
- Remove performance numbers from CPU cycles/packet example (Ferruh)
- Fix typo in CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES (Ferruh)
v2:
- Use shorter lines, up to 100.
---
doc/guides/testpmd_app_ug/testpmd_funcs.rst | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 3ded179ee72a..a808b6a308f2 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -372,6 +372,12 @@ Example for the io forwarding engine, with some packet
drops on the tx side::
TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+.. note::
+
+ Enabling CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES appends "CPU cycles/packet"
stats, like:
+
+ CPU cycles/packet=xx.dd (total cycles=xxxx / total RX packets=xxxx) at xxx
MHz clock
+
clear fwd
~~~~~~~~~
--
2.17.1
