diff mbox

[dpdk-dev,v1] doc: update dpdk proc info limitations

Message ID 20180207214626.34029-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 success Compilation OK

Commit Message

Kovacevic, Marko Feb. 7, 2018, 9:46 p.m. UTC 
  Updated the limitations for dpdk-procinfo
to inform user of the proper use. To avoid
failures and build issues

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

Comments

John McNamara Feb. 8, 2018, 6:08 p.m. UTC | #1 
> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Wednesday, February 7, 2018 9:46 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: [PATCH v1] doc: update dpdk proc info limitations
> 
> Updated the limitations for dpdk-procinfo to inform user of the proper
> use. To avoid failures and build issues
> 


Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon Feb. 8, 2018, 10:07 p.m. UTC | #2 
> > Updated the limitations for dpdk-procinfo to inform user of the proper
> > use. To avoid failures and build issues
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks
diff mbox

Patch

diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst
index b35b02f..d5b5ed6 100644
--- a/doc/guides/tools/proc_info.rst
+++ b/doc/guides/tools/proc_info.rst
@@ -10,17 +10,6 @@  statistics, resetting port statistics and printing DPDK memory information.
 This application extends the original functionality that was supported by
 dump_cfg.
 
-.. note::
-
-    dpdk-procinfo should run alongside primary process with same DPDK version.
-
-.. note::
-
-   When running `dpdk-procinfo`` with shared library mode, it is required to
-   pass the same NIC PMD libraries as used for the primary application. Any
-   mismatch in PMD library arguments can lead to undefined behaviour and results
-   affecting primary application too.
-
 Running the Application
 -----------------------
 The application has a number of command line options:
@@ -52,6 +41,17 @@  If no port mask is specified xstats are reset for all DPDK ports.
 
 **-m**: Print DPDK memory information.
 
-.. note::
+Limitations
+-----------
+
+* dpdk-procinfo should run alongside primary process with same DPDK version.
+
+* When running ``dpdk-procinfo`` with shared library mode, it is required to
+  pass the same NIC PMD libraries as used for the primary application. Any
+  mismatch in PMD library arguments can lead to undefined behaviour and results
+  affecting primary application too.
+
+* Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP.
 
-   Stats retrieval using ``dpdk-procinfo`` is not supported for virtual devices like PCAP and TAP.
+* Since default DPDK EAL arguments for ``dpdk-procinfo`` are ``-c1, -n4 & --proc-type=secondary``,
+  It is not expected that the user passes any EAL arguments.