diff mbox

[dpdk-dev,1/1] testpmd_ug: update userguide with xstats commands

Message ID 1473245157-155016-1-git-send-email-maryam.tahhan@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Commit Message

Tahhan, Maryam Sept. 7, 2016, 10:45 a.m. UTC 
  Update the testpmd user guide with instructions for retrieving extended
NIC statistics.

Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
---
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

Comments

De Lara Guarch, Pablo Oct. 7, 2016, 3:39 a.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Maryam Tahhan
> Sent: Wednesday, September 07, 2016 3:46 AM
> To: dev@dpdk.org
> Cc: Tahhan, Maryam
> Subject: [dpdk-dev] [PATCH 1/1] testpmd_ug: update userguide with xstats
> commands
> 
> Update the testpmd user guide with instructions for retrieving extended
> NIC statistics.
> 
> Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>

Title needs to be modified to something like the following, for convention reasons:
"doc: update testpmd guide with xtats commands"
Apart from this:

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
John McNamara Oct. 7, 2016, 7:12 a.m. UTC | #2 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Maryam Tahhan
> Sent: Wednesday, September 7, 2016 11:46 AM
> To: dev@dpdk.org
> Cc: Tahhan, Maryam <maryam.tahhan@intel.com>
> Subject: [dpdk-dev] [PATCH 1/1] testpmd_ug: update userguide with xstats
> commands
> 
> Update the testpmd user guide with instructions for retrieving extended
> NIC statistics.
> 
> Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon Oct. 13, 2016, 4:14 p.m. UTC | #3 
> > Update the testpmd user guide with instructions for retrieving extended
> > NIC statistics.
> > 
> > Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks
John McNamara April 5, 2017, 8:33 a.m. UTC | #4 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of De Lara Guarch, Pablo
> Sent: Friday, October 7, 2016 4:40 AM
> To: Tahhan, Maryam <maryam.tahhan@intel.com>; dev@dpdk.org
> Cc: Tahhan, Maryam <maryam.tahhan@intel.com>
> Subject: Re: [dpdk-dev] [PATCH 1/1] testpmd_ug: update userguide with
> xstats commands
> 
> 
> 
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Maryam Tahhan
> > Sent: Wednesday, September 07, 2016 3:46 AM
> > To: dev@dpdk.org
> > Cc: Tahhan, Maryam
> > Subject: [dpdk-dev] [PATCH 1/1] testpmd_ug: update userguide with
> > xstats commands
> >
> > Update the testpmd user guide with instructions for retrieving
> > extended NIC statistics.
> >
> > Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
> 
> Title needs to be modified to something like the following, for convention
> reasons:
> "doc: update testpmd guide with xtats commands"

s/xtats/xstats
diff mbox

Patch

diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index f87e0c2..2d4c496 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -35,7 +35,8 @@  Testpmd Runtime Functions
 
 Where the testpmd application is started in interactive mode, (``-i|--interactive``),
 it displays a prompt that can be used to start and stop forwarding,
-configure the application, display statistics, set the Flow Director and other tasks::
+configure the application, display statistics (including the extended NIC
+statistics aka xstats) , set the Flow Director and other tasks::
 
    testpmd>
 
@@ -50,10 +51,10 @@  If you type a partial command and hit ``<TAB>`` you get a list of the available
 
    testpmd> show port <TAB>
 
-       info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
-       info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
-       stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
-       stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
+       info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc X
+       info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc all
+       stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc X
+       stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc all
        ...
 
 
@@ -130,7 +131,7 @@  show port
 
 Display information for a given port or all ports::
 
-   testpmd> show port (info|stats|fdir|stat_qmap|dcb_tc) (port_id|all)
+   testpmd> show port (info|stats|xstats|fdir|stat_qmap|dcb_tc) (port_id|all)
 
 The available information categories are:
 
@@ -138,6 +139,8 @@  The available information categories are:
 
 * ``stats``: RX/TX statistics.
 
+* ``xstats``: RX/TX extended NIC statistics.
+
 * ``fdir``: Flow Director information and statistics.
 
 * ``stat_qmap``: Queue statistics mapping.
@@ -205,7 +208,7 @@  clear port
 
 Clear the port statistics for a given port or for all ports::
 
-   testpmd> clear port (info|stats|fdir|stat_qmap) (port_id|all)
+   testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all)
 
 For example::