From mboxrd@z Thu Jan 1 00:00:00 1970 From: Rosen Xu Subject: [PATCH v2 2/2] [PATCH v2 2/2] doc/guides/testpmd_app_ug: update documentation for added shaper profile parameters Date: Mon, 22 Oct 2018 16:46:41 +0800 Message-ID: <1540198001-127116-3-git-send-email-rosen.xu@intel.com> References: <1534156498-57837-1-git-send-email-rosen.xu@intel.com> <1540198001-127116-1-git-send-email-rosen.xu@intel.com> Cc: cristian.dumitrescu@intel.com, wenzhuo.lu@intel.com, jasvinder.singh@intel.com, rosen.xu@intel.com, ferruh.yigit@intel.com To: dev@dpdk.org Return-path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id D5EA94CE4 for ; Mon, 22 Oct 2018 10:46:34 +0200 (CEST) In-Reply-To: <1540198001-127116-1-git-send-email-rosen.xu@intel.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Update documentation for committed and peak parameters of shaper profile Signed-off-by: Rosen Xu --- doc/guides/testpmd_app_ug/testpmd_funcs.rst | 9 ++++++--- 1 file 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 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 -- 1.8.3.1