[dpdk-dev] app/testpmd: add missing args to TM show cap cmd

Message ID 1517152094-21811-1-git-send-email-tdu@semihalf.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Tomasz Duszynski Jan. 28, 2018, 3:08 p.m. UTC
  Command used for querying node or level capabilities requires
argument which specifies which set of capabilities to show.

Thus trying to show node/level capabilities using current
documentation will not work. Fix that by adding missing
arguments to command documentation.

Fixes: 5b590fbe09b6 ("app/testpmd: add traffic management forwarding mode")
Cc: jasvinder.singh@intel.com

Signed-off-by: Tomasz Duszynski <tdu@semihalf.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--
2.7.4
  

Comments

Jasvinder Singh Jan. 30, 2018, 9:40 a.m. UTC | #1
> -----Original Message-----
> From: Tomasz Duszynski [mailto:tdu@semihalf.com]
> Sent: Sunday, January 28, 2018 3:08 PM
> To: dev@dpdk.org
> Cc: Lu, Wenzhuo <wenzhuo.lu@intel.com>; Wu, Jingjing
> <jingjing.wu@intel.com>; Mcnamara, John <john.mcnamara@intel.com>;
> Kovacevic, Marko <marko.kovacevic@intel.com>; Tomasz Duszynski
> <tdu@semihalf.com>; Singh, Jasvinder <jasvinder.singh@intel.com>
> Subject: [PATCH] app/testpmd: add missing args to TM show cap cmd
> 
> Command used for querying node or level capabilities requires argument
> which specifies which set of capabilities to show.
> 
> Thus trying to show node/level capabilities using current documentation will
> not work. Fix that by adding missing arguments to command documentation.
> 
> Fixes: 5b590fbe09b6 ("app/testpmd: add traffic management forwarding
> mode")
> Cc: jasvinder.singh@intel.com
> 
> Signed-off-by: Tomasz Duszynski <tdu@semihalf.com>

Acked-by: Jasvinder Singh <jasvinder.singh@intel.com>
  
Thomas Monjalon Jan. 31, 2018, 10:38 p.m. UTC | #2
> > Command used for querying node or level capabilities requires argument
> > which specifies which set of capabilities to show.
> > 
> > Thus trying to show node/level capabilities using current documentation will
> > not work. Fix that by adding missing arguments to command documentation.
> > 
> > Fixes: 5b590fbe09b6 ("app/testpmd: add traffic management forwarding
> > mode")
> > Cc: jasvinder.singh@intel.com
> > 
> > Signed-off-by: Tomasz Duszynski <tdu@semihalf.com>
> 
> Acked-by: Jasvinder Singh <jasvinder.singh@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index d8c9ef0..7ab8eea 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -2274,14 +2274,14 @@  show port traffic management capability (hierarchy level)

 Show traffic management hierarchy level capability of the port::

-   testpmd> show port tm cap (port_id) (level_id)
+   testpmd> show port tm level cap (port_id) (level_id)

 show port traffic management capability (hierarchy node level)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

 Show the traffic management hierarchy node capability of the port::

-   testpmd> show port tm cap (port_id) (node_id)
+   testpmd> show port tm node cap (port_id) (node_id)

 show port traffic management hierarchy node type
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~