diff mbox series

doc: add testpmd latencystats option

Message ID 20240109230849.6348-1-stephen@networkplumber.org (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series doc: add testpmd latencystats option |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/github-robot: build success github build: passed
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS

Commit Message

Stephen Hemminger Jan. 9, 2024, 11:08 p.m. UTC 
  Option was added but never added to documentation.

Fixes: 62d3216d6194 ("app/testpmd: add latency statistics calculation")
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/testpmd_app_ug/run_app.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Ferruh Yigit Jan. 10, 2024, 6:11 p.m. UTC | #1 
On 1/9/2024 11:08 PM, Stephen Hemminger wrote:
> Option was added but never added to documentation.
> 
> Fixes: 62d3216d6194 ("app/testpmd: add latency statistics calculation")
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> ---
>  doc/guides/testpmd_app_ug/run_app.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
> index 24a086401ee7..e149373cd235 100644
> --- a/doc/guides/testpmd_app_ug/run_app.rst
> +++ b/doc/guides/testpmd_app_ug/run_app.rst
> @@ -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.
> +
>

Acked-by: Ferruh Yigit <ferruh.yigit@amd.com>

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."
diff mbox series

Patch

diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index 24a086401ee7..e149373cd235 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -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