diff mbox series

[v2,2/2,v2,2/2] doc/guides/testpmd_app_ug: update documentation for added shaper profile parameters

Message ID 1540198001-127116-3-git-send-email-rosen.xu@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Cristian Dumitrescu
Headers
Series Add and identify shaper profile parameters |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Xu, Rosen Oct. 22, 2018, 8:46 a.m. UTC 
  Update documentation for committed and peak parameters of shaper profile

Signed-off-by: Rosen Xu <rosen.xu@intel.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

Comments

Kovacevic, Marko Oct. 22, 2018, 12:28 p.m. UTC | #1 
> Update documentation for committed and peak parameters of shaper
> profile
> 
> Signed-off-by: Rosen Xu <rosen.xu@intel.com>
> ---
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)

Doc patch is ok just the commit heading is a but long 

Running git log check: 47112
Headline too long:
        doc/guides/testpmd_app_ug: update documentation for added shaper profile parameters

Reviewed-by: Marko Kovacevic <marko.kovacevic@intel.com>
diff mbox series

Patch

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index d712bb6..3d07efc 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -2473,13 +2473,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)
 
 where:
 
 * ``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