path: root/doc
diff options
authorRosen Xu <>2018-10-22 16:46:40 +0800
committerThomas Monjalon <>2018-11-05 08:41:03 +0100
commitc2c15f769ab978c8ec5f9e17bd7ae2d63176f276 (patch)
treea09a84f794727f4cbfa8d77895763afc8ea0ccc3 /doc
parent84e7477e10b1149c8b5495df8fa239116c41e459 (diff)
app/testpmd: fix shaper profile parameters
As struct rte_tm_shaper_params defined, the command line of testpmd should include committed and peak parameters, but right now the command line doesn't identify whether it's committed or peak parameter. This patch identifies and adds the clarify definition Fixes: bddc2f40b594 ("app/testpmd: add commands for shaper and wred profiles") Cc: Signed-off-by: Rosen Xu <>
Diffstat (limited to 'doc')
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index e23079b..e3c4606 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -2585,13 +2585,16 @@ Add port traffic management private shaper profile
Add the port traffic management private shaper profile::
testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
- (tb_rate) (tb_size) (packet_length_adjust)
+ (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
+ (packet_length_adjust)
* ``shaper_profile id``: Shaper profile ID for the new profile.
-* ``tb_rate``: Token bucket rate (bytes per second).
-* ``tb_size``: Token bucket size (bytes).
+* ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
+* ``cmit_tb_size``: Committed token bucket size (bytes).
+* ``peak_tb_rate``: Peak token bucket rate (bytes per second).
+* ``peak_tb_size``: Peak token bucket size (bytes).
* ``packet_length_adjust``: The value (bytes) to be added to the length of
each packet for the purpose of shaping. This parameter value can be used to
correct the packet length with the framing overhead bytes that are consumed