From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by dpdk.org (Postfix) with ESMTP id 3DE0E1B75D for ; Wed, 7 Feb 2018 22:46:46 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga002.jf.intel.com ([10.7.209.21]) by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 07 Feb 2018 13:46:44 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,473,1511856000"; d="scan'208";a="32942531" Received: from silpixa00399502.ir.intel.com (HELO silpixa00399502.ger.corp.intel.com) ([10.237.223.218]) by orsmga002.jf.intel.com with ESMTP; 07 Feb 2018 13:46:42 -0800 From: Marko Kovacevic To: dev@dpdk.org Cc: john.mcnamara@intel.com, vipin.varghese@intel.com, Marko Kovacevic Date: Wed, 7 Feb 2018 21:46:26 +0000 Message-Id: <20180207214626.34029-1-marko.kovacevic@intel.com> X-Mailer: git-send-email 2.9.5 Subject: [dpdk-dev] [PATCH v1] doc: update dpdk proc info limitations X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 07 Feb 2018 21:46:47 -0000 Updated the limitations for dpdk-procinfo to inform user of the proper use. To avoid failures and build issues Signed-off-by: Marko Kovacevic --- 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 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. -- 2.9.5