Skip to contentSkip to conversation

doc: update dpdk proc info limitations

PATCH Applied Marko Kovacevic 3 participants 3 messages Feb 7, 2018 – Feb 8, 2018

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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

---
 doc/guides/tools/proc_info.rst | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)
doc/guides/tools/proc_info.rst +13 -13
index b35b02f..d5b5ed6 100644
@@ -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.
Signature · 1 line
2.9.5
Acked-by on v1 1/1
#1 lore raw
Quoted 11 lines

-----Original Message-----
From: Kovacevic, Marko
Sent: Wednesday, February 7, 2018 9:46 PM
To: [email protected]
Cc: Mcnamara, John <[email protected]>; Varghese, Vipin <[email protected]>; Kovacevic, Marko <[email protected]>
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