From bacf34762ac54bdc8906eafeaac6042697128211 Mon Sep 17 00:00:00 2001 From: Marko Kovacevic Date: Wed, 7 Feb 2018 21:46:26 +0000 Subject: [PATCH] doc: update limitations in procinfo guide Updated the limitations for dpdk-procinfo to inform user of the proper use. To avoid failures and build issues Signed-off-by: Marko Kovacevic Acked-by: John McNamara --- doc/guides/tools/proc_info.rst | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/guides/tools/proc_info.rst b/doc/guides/tools/proc_info.rst index b35b02ff23..d5b5ed6a61 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. -- 2.20.1