eventdev: introduce event vector Tx capability

[dpdk.git] / doc / guides / nics / build_and_test.rst

diff --git a/doc/guides/nics/build_and_test.rst b/doc/guides/nics/build_and_test.rst
index 62ac52c..e8b29c2 100644 (file)
--- a/doc/guides/nics/build_and_test.rst
+++ b/doc/guides/nics/build_and_test.rst
@@ -19,45 +19,28 @@ information on how to build and run testpmd.
 Driver Compilation
 ------------------
 
-To compile a PMD for a platform, run make with appropriate target as shown below.
-Use "make" command in Linux and "gmake" in FreeBSD. This will also build testpmd.
+To compile a PMD for a platform, build DPDK
+as described in the "Getting Started Guide" for your platform.
+This will also build testpmd.
 
-To check available targets:
+Detailed instructions are available
+in the :doc:`meson build guide <../prog_guide/build-sdk-meson>`.
 
-.. code-block:: console
+The ethdev layer supports below build options for debug purpose:
 
-   cd <DPDK-source-directory>
-   make showconfigs
+- ``RTE_ETHDEV_DEBUG_RX`` (default **disabled**)
 
-Example output:
+  Build with debug code on Rx path.
 
-.. code-block:: console
+- ``RTE_ETHDEV_DEBUG_TX`` (default **disabled**)
 
-   arm-armv7a-linuxapp-gcc
-   arm64-armv8a-linuxapp-gcc
-   arm64-dpaa2-linuxapp-gcc
-   arm64-thunderx-linuxapp-gcc
-   arm64-xgene1-linuxapp-gcc
-   i686-native-linuxapp-gcc
-   i686-native-linuxapp-icc
-   ppc_64-power8-linuxapp-gcc
-   x86_64-native-bsdapp-clang
-   x86_64-native-bsdapp-gcc
-   x86_64-native-linuxapp-clang
-   x86_64-native-linuxapp-gcc
-   x86_64-native-linuxapp-icc
-   x86_x32-native-linuxapp-gcc
+  Build with debug code on Tx path.
 
-To compile a PMD for Linux x86_64 gcc target, run the following "make" command:
+.. Note::
 
-.. code-block:: console
-
-   make install T=x86_64-native-linuxapp-gcc
-
-Use ARM (ThunderX, DPAA, X-Gene) or PowerPC target for respective platform.
-
-For more information, refer to the :ref:`Getting Started Guide for Linux <linux_gsg>`
-or :ref:`Getting Started Guide for FreeBSD <freebsd_gsg>` depending on your platform.
+   The ethdev library use above options to wrap debug code to trace invalid parameters
+   on data path APIs, so performance downgrade is expected when enabling those options.
+   Each PMD can decide to reuse them to wrap their own debug code in the Rx/Tx path.
 
 Running testpmd in Linux
 ------------------------
@@ -97,12 +80,18 @@ This section demonstrates how to setup and run ``testpmd`` in Linux.
 
          Hugepagesize:       2048 kB
 
+   Mount and request above can be achieved simply with this tool:
+
+   .. code-block:: console
+
+      dpdk-hugepages.py --setup 2G
+
 #. Load ``igb_uio`` or ``vfio-pci`` driver:
 
    .. code-block:: console
 
       modprobe uio
-      insmod ./x86_64-native-linuxapp-gcc/kmod/igb_uio.ko
+      insmod igb_uio.ko
 
    or
 
@@ -139,7 +128,7 @@ This section demonstrates how to setup and run ``testpmd`` in Linux.
 
    .. code-block:: console
 
-      ./x86_64-native-linuxapp-gcc/app/testpmd -l 0-3 -n 4 -- -i
+      ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i
 
    Successful execution will show initialization messages from EAL, PMD and
    testpmd application. A prompt will be displayed at the end for user commands
@@ -151,3 +140,7 @@ 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 ``testpmd`` is built with shared library, use option ``-d`` to load
+      the dynamic PMD for ``rte_eal_init``.