From e4aa3617c77653361e1d52dc3c48c21c9002a573 Mon Sep 17 00:00:00 2001 From: Bo Chen Date: Tue, 16 Jul 2024 09:51:00 -0700 Subject: [PATCH] docs: performance_metrics: Wrap line at 80 characters Signed-off-by: Bo Chen --- docs/performance_metrics.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/performance_metrics.md b/docs/performance_metrics.md index 8e12a1f0e..cd3c3ebd2 100644 --- a/docs/performance_metrics.md +++ b/docs/performance_metrics.md @@ -37,9 +37,11 @@ $ ./scripts/dev_cli.sh tests --metrics -- -- --timeout 5 --iterations 10 ## Performance Tests Details -The following table lists the supported performance tests with default timeout and number of iterations. -The `timeout` defines the maximum execution time of each test for each iteration. -The `iteration` defines how many times a test needs to be executed to generate the final metrics data. +The following table lists the supported performance tests with default +timeout and number of iterations. The `timeout` defines the maximum +execution time of each test for each iteration. The `iteration` defines +how many times a test needs to be executed to generate the final metrics +data. | **Type** | **Metric** | **Timeout(s)** | **Iterations** | |------------|--------------------------------------------|----------------|----------------| @@ -52,7 +54,7 @@ The `iteration` defines how many times a test needs to be executed to generate t | | virtio_net_throughput_single_queue_tx_gbps | 10 | 5 | | | virtio_net_throughput_multi_queue_rx_gbps | 10 | 5 | | | virtio_net_throughput_multi_queue_tx_gbps | 10 | 5 | -| Block | block_read_MiBps | 10 | 5 | +| Block | block_read_MiBps | 10 | 5 | | | block_write_MiBps | 10 | 5 | | | block_random_read_MiBps | 10 | 5 | | | block_random_write_MiBps | 10 | 5 | @@ -71,8 +73,8 @@ The `iteration` defines how many times a test needs to be executed to generate t ## Output Format -Performance-metrics output the result into a json file if `report-file` param is set. -The fields included in JSON include: +Performance-metrics output the result into a json file if `report-file` +param is set. The fields included in JSON include: | Field Name | Content | |--------------------|------------------------------------------|