[dpdk-dev] doc: update the usage for shared library

Message ID 1517840230-8982-1-git-send-email-vipin.varghese@intel.com
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show

Checks

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

Commit Message

Vipin Varghese Feb. 5, 2018, 2:17 p.m.
Add note information to intimate about use of option '-d' for shared
library in DPDK application.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---
 doc/guides/nics/build_and_test.rst | 5 +++++
 1 file changed, 5 insertions(+)

Comments

Mcnamara, John Feb. 6, 2018, 12:17 p.m. | #1
> -----Original Message-----
> From: Varghese, Vipin
> Sent: Monday, February 5, 2018 2:17 PM
> To: dev@dpdk.org; Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: [PATCH] doc: update the usage for shared library
> 
> Add note information to intimate about use of option '-d' for shared
> ...
> +
> +   .. note::
> +
> +   When dpdk-testpmd is built with shared library, use option ``-d`` to
> +   load the dynamic PMD for ``rte_eal_init``.

I think the text of the note needs to be indented at least 3 spaces.

Also, the app name is testpmd, not dpdk-testpmd, right? That is what is in
the previous section of the doc.

Also, quote the application name like this: ``testpmd``.


John

Patch

diff --git a/doc/guides/nics/build_and_test.rst b/doc/guides/nics/build_and_test.rst
index 62ac52c..9a96343 100644
--- a/doc/guides/nics/build_and_test.rst
+++ b/doc/guides/nics/build_and_test.rst
@@ -151,3 +151,8 @@  This section demonstrates how to setup and run ``testpmd`` in Linux.
 
    Refer to the :ref:`testpmd runtime functions <testpmd_runtime>` for a list
    of available commands.
+
+   .. note::
+
+   When dpdk-testpmd is built with shared library, use option ``-d`` to
+   load the dynamic PMD for ``rte_eal_init``.