[dpdk-dev,v1] doc: add note in proc info for stats retrieval

Message ID 20180124164726.23793-1-marko.kovacevic@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

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

Commit Message

Kovacevic, Marko Jan. 24, 2018, 4:47 p.m. UTC
  Note added to outline that using
proc_info for virtual devices is not supported

Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
---
 doc/guides/tools/proc_info.rst | 3 +++
 1 file changed, 3 insertions(+)
  

Comments

Deepak Kumar JAIN Jan. 26, 2018, 4:37 p.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Marko Kovacevic
> Sent: Wednesday, January 24, 2018 4:47 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>
> Subject: [dpdk-dev] [PATCH v1] doc: add note in proc info for stats retrieval
> 
> Note added to outline that using
> proc_info for virtual devices is not supported
> 
> Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
> ---
>  doc/guides/tools/proc_info.rst | 3 +++
>  1 file changed, 3 insertions(+)
> 
>  **-m**: Print DPDK memory information.
> +
> +.. NOTE::
> +   NOTE: Stats retrieval using ``proc_info`` is not supported for
> +virtual devices like PCAP and TAP
> --
> 2.9.5

Acked-by: Deepak Kumar Jain <deepak.k.jain@intel.com>
  
Thomas Monjalon Feb. 1, 2018, 2:30 a.m. UTC | #2
24/01/2018 17:47, Marko Kovacevic:
> Note added to outline that using
> proc_info for virtual devices is not supported
> 
> Signed-off-by: Marko Kovacevic <marko.kovacevic@intel.com>
> ---
> +.. NOTE::
> +   NOTE: Stats retrieval using ``proc_info`` is not supported for virtual devices like PCAP and TAP
> 

Reworded a little:

.. note::

   Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP.

And applied, thanks.
  

Patch

diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
index fd17e27..191ab20 100644
--- a/doc/guides/tools/proc_info.rst
+++ b/doc/guides/tools/proc_info.rst
@@ -68,3 +68,6 @@  The xstats-reset parameter controls the resetting of extended port statistics.
 If no port mask is specified xstats are reset for all DPDK ports.
 
 **-m**: Print DPDK memory information.
+
+.. NOTE::
+   NOTE: Stats retrieval using ``proc_info`` is not supported for virtual devices like PCAP and TAP