diff mbox series

[4/5] docs: add description of apistats parameter into proc-info

Message ID 20201204075109.14694-5-yamashita.hideyuki@ntt-tx.co.jp (mailing list archive)
State Rejected
Delegated to: Ferruh Yigit
Headers show
Series add apistats function | expand

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Hideyuki Yamashita Dec. 4, 2020, 7:51 a.m. UTC
This patch modifies document of proc-info to introduce "--apistats"
parameter.

Signed-off-by: Hideyuki Yamashita <yamashtia.hideyuki@ntt-tx.co.jp>
---
 doc/guides/tools/proc_info.rst | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

Comments

Varghese, Vipin Dec. 5, 2020, 1:02 p.m. UTC | #1
@Tahhan, Maryam and @Pattan, Reshma should not documentation and code change of proc-info be in the same patch request?

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Hideyuki Yamashita
> Sent: Friday, December 4, 2020 1:21 PM
> To: Tahhan, Maryam <maryam.tahhan@intel.com>; Pattan, Reshma
> <reshma.pattan@intel.com>
> Cc: dev@dpdk.org; Hideyuki Yamashita <yamashita.hideyuki@ntt-tx.co.jp>;
> Hideyuki Yamashita <yamashtia.hideyuki@ntt-tx.co.jp>
> Subject: [dpdk-dev] [PATCH 4/5] docs: add description of apistats parameter
> into proc-info
> 
> This patch modifies document of proc-info to introduce "--apistats"
> parameter.
> 
> Signed-off-by: Hideyuki Yamashita <yamashtia.hideyuki@ntt-tx.co.jp>
> ---
>  doc/guides/tools/proc_info.rst | 10 ++++++++--
>  1 file changed, 8 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
> index 9772d97..4c7b79e 100644
> --- a/doc/guides/tools/proc_info.rst
> +++ b/doc/guides/tools/proc_info.rst
> @@ -18,8 +18,9 @@ The application has a number of command line options:
>  .. code-block:: console
> 
>     ./<build_dir>/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
> -   --stats-reset | --xstats-reset] [ --show-port | --show-tm | --show-crypto |
> -   --show-ring[=name] | --show-mempool[=name] | --iter-mempool=name ]
> +   --stats-reset | --xstats-reset | --apistats ] [ --show-port | --show-tm |
> +   --show-crypto | --show-ring[=name] | --show-mempool[=name] |
> +   --iter-mempool=name ]
> 
>  Parameters
>  ~~~~~~~~~~
> @@ -41,6 +42,11 @@ no port mask is specified, the generic stats are reset for
> all DPDK ports.
>  The xstats-reset parameter controls the resetting of extended port statistics.
>  If no port mask is specified xstats are reset for all DPDK ports.
> 
> +**--apistats**
> +The apistats parameter controls rx_burst/tx_burst API invocation
> +counter statistics per core. If no port mask is specified apistats are
> +printed for all DPDK ports.
> +
>  **-m**: Print DPDK memory information.
> 
>  **--show-port**
> --
> 2.18.0
Pattan, Reshma Dec. 7, 2020, 9:48 a.m. UTC | #2
> -----Original Message-----
> From: Varghese, Vipin <vipin.varghese@intel.com>
> @Tahhan, Maryam and @Pattan, Reshma should not documentation and code
> change of proc-info be in the same patch request?

If code changes and doc changes are related, yes they should be combined in one patch. That is what the case here I guess.
diff mbox series

Patch

diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
index 9772d97..4c7b79e 100644
--- a/doc/guides/tools/proc_info.rst
+++ b/doc/guides/tools/proc_info.rst
@@ -18,8 +18,9 @@  The application has a number of command line options:
 .. code-block:: console
 
    ./<build_dir>/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
-   --stats-reset | --xstats-reset] [ --show-port | --show-tm | --show-crypto |
-   --show-ring[=name] | --show-mempool[=name] | --iter-mempool=name ]
+   --stats-reset | --xstats-reset | --apistats ] [ --show-port | --show-tm |
+   --show-crypto | --show-ring[=name] | --show-mempool[=name] |
+   --iter-mempool=name ]
 
 Parameters
 ~~~~~~~~~~
@@ -41,6 +42,11 @@  no port mask is specified, the generic stats are reset for all DPDK ports.
 The xstats-reset parameter controls the resetting of extended port statistics.
 If no port mask is specified xstats are reset for all DPDK ports.
 
+**--apistats**
+The apistats parameter controls rx_burst/tx_burst API invocation counter
+statistics per core. If no port mask is specified apistats are printed for all
+DPDK ports.
+
 **-m**: Print DPDK memory information.
 
 **--show-port**