Skip to contentSkip to conversation

doc: add testpmd latencystats option

PATCH Applied Stephen Hemminger 2 participants 2 messages Jan 9, 2024 – Jan 10, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: add testpmd latencystats option

Option was added but never added to documentation.

Fixes 62d3216d6194 ("app/testpmd: add latency statistics calculation")
---
 doc/guides/testpmd_app_ug/run_app.rst | 4 ++++
 1 file changed, 4 insertions(+)
doc/guides/testpmd_app_ug/run_app.rst +4 -0
index 24a086401ee7..e149373cd235 100644
@@ -422,6 +422,10 @@ The command line options are:
 
     Set the logical core N to perform bitrate calculation.
 
+*   ``--latencystats=N``
+
+    Set the logical core N to perform latency calculation.
+
 *   ``--print-event <unknown|intr_lsc|queue_state|intr_reset|vf_mbox|macsec|intr_rmv|dev_probed|dev_released|flow_aged|err_recovering|recovery_success|recovery_failed|all>``
 
     Enable printing the occurrence of the designated event. Using all will
Signature · 1 line
2.43.0
Acked-by on v1 1/1 Applied
#1 lore raw
Quoted 13 lines · Stephen Hemminger

Option was added but never added to documentation.

Fixes 62d3216d6194 ("app/testpmd: add latency statistics calculation")
---
 doc/guides/testpmd_app_ug/run_app.rst | 4 ++++
 1 file changed, 4 insertions(+)
doc/guides/testpmd_app_ug/run_app.rst +0 -0
index 24a086401ee7..e149373cd235 100644

doc/guides/testpmd_app_ug/run_app.rst The command line options are: · line 429

Quoted 8 lines
doc/guides/testpmd_app_ug/run_app.rst +4 -0
@@ -422,6 +422,10 @@ The command line options are:
 
     Set the logical core N to perform bitrate calculation.
 
+*   ``--latencystats=N``
+
+    Set the logical core N to perform latency calculation.
+
 

Applied to dpdk-next-net/main, thanks.

Help output also mentions from jitter calculation [1] and jitter is actually calculated, so changed document as following while merging:

"Set the logical core N to perform latency and jitter calculations."

[1]
In 'app/test-pmd/parameters.c', help documents as following:
" --latencystats=N: enable latency and jitter statistics monitoring
on forwarding lcore id N."