[dpdk-dev] doc: fix description of traffic management function in testpmd

Message ID 20171026110650.79643-1-jasvinder.singh@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers

Checks

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

Commit Message

Jasvinder Singh Oct. 26, 2017, 11:06 a.m. UTC
  Fixes: 5b590fbe09b6 ("app/testpmd: add traffic management forwarding mode")

Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)
  

Comments

John McNamara Nov. 2, 2017, 5:04 p.m. UTC | #1
> -----Original Message-----
> From: Singh, Jasvinder
> Sent: Thursday, October 26, 2017 12:07 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>
> Subject: [PATCH] doc: fix description of traffic management function in
> testpmd
> 
> Fixes: 5b590fbe09b6 ("app/testpmd: add traffic management forwarding
> mode")
> 
> Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Ferruh Yigit Nov. 7, 2017, 7:13 a.m. UTC | #2
On 11/2/2017 10:04 AM, Mcnamara, John wrote:
> 
> 
>> -----Original Message-----
>> From: Singh, Jasvinder
>> Sent: Thursday, October 26, 2017 12:07 PM
>> To: dev@dpdk.org
>> Cc: Mcnamara, John <john.mcnamara@intel.com>
>> Subject: [PATCH] doc: fix description of traffic management function in
>> testpmd
>>
>> Fixes: 5b590fbe09b6 ("app/testpmd: add traffic management forwarding
>> mode")
>>
>> Signed-off-by: Jasvinder Singh <jasvinder.singh@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied to dpdk/master, thanks.
  

Patch

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 46e4db5..3f1e0d2 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -2227,7 +2227,8 @@  Add nonleaf node to port traffic management hiearchy::
 
    testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
    (priority) (weight) (level_id) (shaper_profile_id) \
-   (shared_shaper_id) (n_shared_shapers) (n_sp_priorities) (stats_mask) \
+   (n_sp_priorities) (stats_mask) (n_shared_shapers) \
+   [(shared_shaper_0) (shared_shaper_1) ...] \
 
 where:
 
@@ -2240,10 +2241,10 @@  where:
 * ``level_id``: Hiearchy level of the node.
 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
   the node.
-* ``shared_shaper_id``: Shared shaper id.
-* ``n_shared_shapers``: Number of shared shapers.
 * ``n_sp_priorities``: Number of strict priorities.
 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
+* ``n_shared_shapers``: Number of shared shapers.
+* ``shared_shaper_id``: Shared shaper id.
 
 Add port traffic management hierarchy leaf node
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -2252,8 +2253,8 @@  Add leaf node to port traffic management hiearchy::
 
    testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
    (priority) (weight) (level_id) (shaper_profile_id) \
-   (shared_shaper_id) (n_shared_shapers) (cman_mode) \
-   (wred_profile_id) (stats_mask) \
+   (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
+   [(shared_shaper_id) (shared_shaper_id) ...] \
 
 where:
 
@@ -2266,11 +2267,11 @@  where:
 * ``level_id``: Hiearchy level of the node.
 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
   the node.
-* ``shared_shaper_id``: Shared shaper id.
-* ``n_shared_shapers``: Number of shared shapers.
 * ``cman_mode``: Congestion management mode to be enabled for this node.
 * ``wred_profile_id``: WRED profile id to be enabled for this node.
 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
+* ``n_shared_shapers``: Number of shared shapers.
+* ``shared_shaper_id``: Shared shaper id.
 
 Delete port traffic management hierarchy node
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~