Skip to contentSkip to conversation

remove make support in DPDK

PATCH Superseded Ciara Power 24 participants 300 messages Aug 7, 2020 – Oct 22, 2020 Page 5 of 7

Subsystems (12)
lore
Share & tools
lore
#187 lore raw

PATCH v4 19/31 doc: remove references to make from prog guide

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/prog_guide/env_abstraction_layer.rst | 17 ++++++-----------
 doc/guides/prog_guide/graph_lib.rst             |  6 ++----
 .../prog_guide/ip_fragment_reassembly_lib.rst   |  5 -----
 doc/guides/prog_guide/kernel_nic_interface.rst  | 14 +++++++-------
 .../link_bonding_poll_mode_drv_lib.rst          | 15 ++++++++-------
 doc/guides/prog_guide/lto.rst                   | 12 +-----------
 doc/guides/prog_guide/mbuf_lib.rst              |  4 ++--
 doc/guides/prog_guide/mempool_lib.rst           |  7 +++----
 doc/guides/prog_guide/profile_app.rst           | 17 +++--------------
 doc/guides/prog_guide/qos_framework.rst         | 10 +---------
 doc/guides/prog_guide/rcu_lib.rst               |  7 +++----
 doc/guides/prog_guide/trace_lib.rst             |  3 +--
 .../prog_guide/writing_efficient_code.rst       |  3 +--
 13 files changed, 38 insertions(+), 82 deletions(-)
doc/guides/prog_guide/env_abstraction_layer.rst +6 -11
index f64ae953d1..936c885081 100644
@@ -201,16 +201,16 @@ each segment is strictly one physical page. It is possible to change the amount
 of virtual memory being preallocated at startup by editing the following config
 variables:
 
-* ``CONFIG_RTE_MAX_MEMSEG_LISTS`` controls how many segment lists can DPDK have
-* ``CONFIG_RTE_MAX_MEM_MB_PER_LIST`` controls how much megabytes of memory each
+* ``RTE_MAX_MEMSEG_LISTS`` controls how many segment lists can DPDK have
+* ``RTE_MAX_MEM_MB_PER_LIST`` controls how much megabytes of memory each
   segment list can address
-* ``CONFIG_RTE_MAX_MEMSEG_PER_LIST`` controls how many segments each segment can
+* ``RTE_MAX_MEMSEG_PER_LIST`` controls how many segments each segment can
   have
-* ``CONFIG_RTE_MAX_MEMSEG_PER_TYPE`` controls how many segments each memory type
+* ``RTE_MAX_MEMSEG_PER_TYPE`` controls how many segments each memory type
   can have (where "type" is defined as "page size + NUMA node" combination)
-* ``CONFIG_RTE_MAX_MEM_MB_PER_TYPE`` controls how much megabytes of memory each
+* ``RTE_MAX_MEM_MB_PER_TYPE`` controls how much megabytes of memory each
   memory type can address
-* ``CONFIG_RTE_MAX_MEM_MB`` places a global maximum on the amount of memory
+* ``RTE_MAX_MEM_MB`` places a global maximum on the amount of memory
   DPDK can reserve
 
 Normally, these options do not need to be changed.
@@ -715,11 +715,6 @@ However, they can be used in configuration code.
 Refer to the rte_malloc() function description in the *DPDK API Reference*
 manual for more information.
 
-Cookies
-~~~~~~~
-
-When CONFIG_RTE_MALLOC_DEBUG is enabled, the allocated memory contains
-overwrite protection fields to help identify buffer overflows.
 
 Alignment and NUMA Constraints
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
doc/guides/prog_guide/graph_lib.rst +2 -4
index 669d77c740..c922d10f3d 100644
@@ -45,13 +45,11 @@ Performance tuning parameters
 -----------------------------
 
 - Test with various burst size values (256, 128, 64, 32) using
-  CONFIG_RTE_GRAPH_BURST_SIZE config option.
+  RTE_GRAPH_BURST_SIZE config option.
   The testing shows, on x86 and arm64 servers, The sweet spot is 256 burst
   size. While on arm64 embedded SoCs, it is either 64 or 128.
-- Disable node statistics (using ``CONFIG_RTE_LIBRTE_GRAPH_STATS`` config option)
+- Disable node statistics (using ``RTE_LIBRTE_GRAPH_STATS`` config option)
   if not needed.
-- Use arm64 optimized memory copy for arm64 architecture by
-  selecting ``CONFIG_RTE_ARCH_ARM64_MEMCPY``.
 
 Programming model
 -----------------
doc/guides/prog_guide/ip_fragment_reassembly_lib.rst +0 -5
index 6ac1bba649..314d4adbb8 100644
@@ -103,8 +103,3 @@ Debug logging and Statistics Collection
 
 The RTE_LIBRTE_IP_FRAG_TBL_STAT config macro controls statistics collection for the Fragment Table.
 This macro is not enabled by default.
-
-The RTE_LIBRTE_IP_FRAG_DEBUG controls debug logging of IP fragments processing and reassembling.
-This macro is disabled by default.
-Note that while logging contains a lot of detailed information,
-it slows down packet processing and might cause the loss of a lot of packets.
doc/guides/prog_guide/kernel_nic_interface.rst +7 -7
index 32d09ccf82..de5d75bd4c 100644
@@ -65,7 +65,7 @@ disabled, and the default carrier state of KNI interfaces is set to *off*.
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko
 
 .. _kni_loopback_mode:
 
@@ -77,14 +77,14 @@ by specifying the ``lo_mode`` parameter:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko lo_mode=lo_mode_fifo
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo
 
 The ``lo_mode_fifo`` loopback option will loop back ring enqueue/dequeue
 operations in kernel space.
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko lo_mode=lo_mode_fifo_skb
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo_skb
 
 The ``lo_mode_fifo_skb`` loopback option will loop back ring enqueue/dequeue
 operations and sk buffer copies in kernel space.
@@ -105,7 +105,7 @@ Single kernel thread mode is enabled as follows:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko kthread_mode=single
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko kthread_mode=single
 
 This mode will create only one kernel thread for all KNI interfaces to
 receive data on the kernel side.  By default, this kernel thread is not
@@ -122,7 +122,7 @@ kernel thread mode is enabled as follows:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko kthread_mode=multiple
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko kthread_mode=multiple
 
 This mode will create a separate kernel thread for each KNI interface to
 receive data on the kernel side.  The core affinity of each ``kni_thread``
@@ -163,13 +163,13 @@ To set the default carrier state to *on*:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko carrier=on
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko carrier=on
 
 To set the default carrier state to *off*:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko carrier=off
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko carrier=off
 
 If the ``carrier`` parameter is not specified, the default carrier state
 of KNI interfaces will be set to *off*.
doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +8 -7
index 2459fd243e..244dca56c4 100644
@@ -28,8 +28,9 @@ bonded device and its slave devices.
 .. note::
 
     The Link Bonding PMD Library is enabled by default in the build
-    configuration files, the library can be disabled by setting
-    ``CONFIG_RTE_LIBRTE_PMD_BOND=n`` and recompiling the DPDK.
+    configuration, the library can be disabled using the meson option
+    "-Ddisable_drivers=net/bond".
+
 
 Link Bonding Modes Overview
 ---------------------------
@@ -377,7 +378,7 @@ Device names and bonding options must be separated by commas as shown below:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..'
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..'
 
 Link Bonding EAL Options
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -477,22 +478,22 @@ Create a bonded device in round robin mode with two slaves specified by their PC
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00' -- --port-topology=chained
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00' -- --port-topology=chained
 
 Create a bonded device in round robin mode with two slaves specified by their PCI address and an overriding MAC address:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained
 
 Create a bonded device in active backup mode with two slaves specified, and a primary slave specified by their PCI addresses:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,slave=0000:0a:00.01,slave=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,slave=0000:0a:00.01,slave=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained
 
 Create a bonded device in balance mode with two slaves specified by their PCI addresses, and a transmission policy of layer 3 + 4 forwarding:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,slave=0000:0a:00.01,slave=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,slave=0000:0a:00.01,slave=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained
doc/guides/prog_guide/lto.rst +1 -11
index 277a6f1090..f79c449598 100644
@@ -26,17 +26,7 @@ need to explicitly initialize variable in order to silence the compiler.
 Please note that turning LTO on causes considerable extension of
 build time.
 
-When using make based build, link time optimization can be enabled for
-the whole DPDK by setting:
-
-.. code-block:: console
-
-    CONFIG_RTE_ENABLE_LTO=y
-
-in config file.
-
-For the meson based build it can be enabled by setting meson built-in
-'b_lto' option:
+Link time optimization can be enabled by setting meson built-in 'b_lto' option:
 
 .. code-block:: console
 
doc/guides/prog_guide/mbuf_lib.rst +2 -2
index c3dbfb9221..2f190b40e4 100644
@@ -266,8 +266,8 @@ can be found in several of the sample applications, for example, the IPv4 Multic
 Debug
 -----
 
-In debug mode (CONFIG_RTE_MBUF_DEBUG is enabled),
-the functions of the mbuf library perform sanity checks before any operation (such as, buffer corruption, bad type, and so on).
+In debug mode, the functions of the mbuf library perform sanity checks before any operation (such as, buffer corruption,
+bad type, and so on).
 
 Use Cases
 ---------
doc/guides/prog_guide/mempool_lib.rst +3 -4
index e3e1f940be..f0bdcd3be1 100644
@@ -17,14 +17,13 @@ This library is used by the :ref:`Mbuf Library <Mbuf_Library>`.
 Cookies
 -------
 
-In debug mode (CONFIG_RTE_LIBRTE_MEMPOOL_DEBUG is enabled), cookies are added at the beginning and end of allocated blocks.
+In debug mode, cookies are added at the beginning and end of allocated blocks.
 The allocated objects then contain overwrite protection fields to help debugging buffer overflows.
 
 Stats
 -----
 
-In debug mode (CONFIG_RTE_LIBRTE_MEMPOOL_DEBUG is enabled),
-statistics about get from/put in the pool are stored in the mempool structure.
+In debug mode, statistics about get from/put in the pool are stored in the mempool structure.
 Statistics are per-lcore to avoid concurrent access to statistics counters.
 
 Memory Alignment Constraints on x86 architecture
@@ -90,7 +89,7 @@ the speed at which a core can access its own cache for a specific memory pool wi
 The cache is composed of a small, per-core table of pointers and its length (used as a stack).
 This internal cache can be enabled or disabled at creation of the pool.
 
-The maximum size of the cache is static and is defined at compilation time (CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE).
+The maximum size of the cache is static and is defined at compilation time (RTE_MEMPOOL_CACHE_MAX_SIZE).
 
 :numref:`figure_mempool` shows a cache in operation.
 
doc/guides/prog_guide/profile_app.rst +3 -14
index e5d0e9079e..7093681983 100644
@@ -33,14 +33,6 @@ Refer to the
 for details about application profiling.
 
 
-Profiling with VTune
-~~~~~~~~~~~~~~~~~~~~
-
-To allow VTune attaching to the DPDK application, reconfigure and recompile
-the DPDK with ``CONFIG_RTE_ETHDEV_RXTX_CALLBACKS`` and
-``CONFIG_RTE_ETHDEV_PROFILE_WITH_VTUNE`` enabled.
-
-
 Profiling on ARM64
 ------------------
 
@@ -76,8 +68,7 @@ cycle counter for user space access by configuring the PMU from the privileged
 mode (kernel space).
 
 By default the ``rte_rdtsc()`` implementation uses a portable ``cntvct_el0``
-scheme.  Application can choose the PMU based implementation with
-``CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU``.
+scheme.
 
 The example below shows the steps to configure the PMU based cycle counter on
 an ARMv8 machine.
@@ -88,10 +79,8 @@ an ARMv8 machine.
     cd armv8_pmu_cycle_counter_el0
     make
     sudo insmod pmu_el0_cycle_counter.ko
-    cd $DPDK_DIR
-    make config T=arm64-armv8a-linux-gcc
-    echo "CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU=y" >> build/.config
-    make
+
+Please refer to :doc:`../linux_gsg/build_dpdk` for details on compiling DPDK with meson.
 
 .. warning::
 
doc/guides/prog_guide/qos_framework.rst +1 -9
index a159709450..4e4ea33ccb 100644
@@ -1525,15 +1525,7 @@ Integration with the DPDK QoS Scheduler
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 RED functionality in the DPDK QoS scheduler is disabled by default.
-To enable it, use the DPDK configuration parameter:
-
-::
-
-    CONFIG_RTE_SCHED_RED=y
-
-This parameter must be set to y.
-The parameter is found in the build configuration files in the DPDK/config directory,
-for example, DPDK/config/common_linux.
+The parameter is found in the build configuration files in the DPDK/config directory.
 RED configuration parameters are specified in the rte_red_params structure within the rte_sched_port_params structure
 that is passed to the scheduler on initialization.
 RED parameters are specified separately for four traffic classes and three packet colors (green, yellow and red)
doc/guides/prog_guide/rcu_lib.rst +3 -4
index d142d0c79d..d0aef3bc16 100644
@@ -186,10 +186,9 @@ they entered a quiescent state. This API checks if a writer has triggered a
 quiescent state query and update the state accordingly.
 
 The ``rte_rcu_qsbr_lock()`` and ``rte_rcu_qsbr_unlock()`` are empty functions.
-However, when ``CONFIG_RTE_LIBRTE_RCU_DEBUG`` is enabled, these APIs aid
-in debugging issues. One can mark the access to shared data structures on the
-reader side using these APIs. The ``rte_rcu_qsbr_quiescent()`` will check if
-all the locks are unlocked.
+However, these APIs can aid in debugging issues. One can mark the access to
+shared data structures on the reader side using these APIs. The
+``rte_rcu_qsbr_quiescent()`` will check if all the locks are unlocked.
 
 Resource reclamation framework for DPDK
 ---------------------------------------
doc/guides/prog_guide/trace_lib.rst +1 -2
index 9bbfd165d8..fbadf9fde9 100644
@@ -135,8 +135,7 @@ In order to avoid performance impact in fast path code, the library introduced
 the user must use ``RTE_TRACE_POINT_FP`` instead of ``RTE_TRACE_POINT``.
 
 ``RTE_TRACE_POINT_FP`` is compiled out by default and it can be enabled using
-``CONFIG_RTE_ENABLE_TRACE_FP`` configuration parameter.
-The ``enable_trace_fp`` option shall be used for the same for meson build.
+the ``enable_trace_fp`` option for meson build.
 
 Event record mode
 -----------------
doc/guides/prog_guide/writing_efficient_code.rst +1 -2
index 2639ef7bf6..db2f1ddbc2 100644
@@ -258,8 +258,7 @@ For instance:
 Setting the Target CPU Type
 ---------------------------
 
-The DPDK supports CPU microarchitecture-specific optimizations by means of CONFIG_RTE_MACHINE option
-in the DPDK configuration file.
+The DPDK supports CPU microarchitecture-specific optimizations by means of RTE_MACHINE option.
 The degree of optimization depends on the compiler's ability to optimize for a specific microarchitecture,
 therefore it is preferable to use the latest compiler versions whenever possible.
 
Signature · 1 line
2.28.0
#188 lore raw

PATCH v4 20/31 doc: remove references to make from platforms guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/platform/bluefield.rst | 22 ---------------------
 doc/guides/platform/octeontx.rst  | 33 +------------------------------
 doc/guides/platform/octeontx2.rst | 32 ------------------------------
 3 files changed, 1 insertion(+), 86 deletions(-)
doc/guides/platform/bluefield.rst +0 -22
index deda675b75..366f2b23a7 100644
@@ -60,17 +60,6 @@ Native Compilation
 Refer to :doc:`../nics/mlx5` for prerequisites. Either Mellanox OFED/EN or
 rdma-core library with corresponding kernel drivers is required.
 
-make build
-^^^^^^^^^^
-
-.. code-block:: console
-
-        make config T=arm64-bluefield-linux-gcc
-        make -j
-
-meson build
-^^^^^^^^^^^
-
 .. code-block:: console
 
         meson build
@@ -126,17 +115,6 @@ Then, untar the tarball at the cross toolchain directory on the x86 host.
         cd $(dirname $(which aarch64-linux-gnu-gcc))/..
         tar xf aarch64-linux-gnu-mlx.tar
 
-make build
-^^^^^^^^^^
-
-.. code-block:: console
-
-        make config T=arm64-bluefield-linux-gcc
-        make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n
-
-meson build
-^^^^^^^^^^^
-
 .. code-block:: console
 
         meson build --cross-file config/arm/arm64_bluefield_linux_gcc
doc/guides/platform/octeontx.rst +1 -32
index 7d1cb647d3..9c20ce437d 100644
@@ -90,23 +90,8 @@ native architecture, the linux sources need to be compiled once natively.
 
 The above steps would rebuild the modules and the required intermediate binaries.
 Once the target is ready for native compilation, the OCTEON TX platform
-drivers can be compiled with the following steps,
+drivers can be compiled, see :doc:`../linux_gsg/build_dpdk` for details.
 
-.. code-block:: console
-
-        cd <dpdk directory>
-        make config T=arm64-thunderx-linux-gcc
-        make
-
-The example applications can be compiled using the following:
-
-.. code-block:: console
-
-        cd <dpdk directory>
-        export RTE_SDK=$PWD
-        export RTE_TARGET=build
-        cd examples/<application>
-        make
 
 Cross Compilation
 ~~~~~~~~~~~~~~~~~
@@ -139,23 +124,7 @@ SDK 6.2.0 patch 3:
 The above steps will prepare build system with numa additions. Now this build system can be used
 to build applications for **OCTEON TX** :sup:`®` platforms.
 
-.. code-block:: console
-
-        cd <dpdk directory>
-        export RTE_SDK=$PWD
-        export RTE_KERNELDIR=$THUNDER_ROOT/linux/kernel/linux
-        make config T=arm64-thunderx-linux-gcc
-        make -j CROSS=aarch64-thunderx-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n EXTRA_CFLAGS="-isystem <numa_install_dir>/include" EXTRA_LDFLAGS="-L<numa_install_dir>/lib -lnuma"
-
 If NUMA support is not required, it can be disabled as explained in
 :doc:`../linux_gsg/cross_build_dpdk_for_arm64`.
 
-Following steps could be used in that case.
-
-.. code-block:: console
-
-        make config T=arm64-thunderx-linux-gcc
-        make CROSS=aarch64-thunderx-linux-gnu-
-
-
 SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.
doc/guides/platform/octeontx2.rst +0 -32
index 13255eec5c..232f628366 100644
@@ -498,27 +498,6 @@ an x86 based platform.
 Native Compilation
 ~~~~~~~~~~~~~~~~~~
 
-make build
-^^^^^^^^^^
-
-.. code-block:: console
-
-        make config T=arm64-octeontx2-linux-gcc
-        make -j
-
-The example applications can be compiled using the following:
-
-.. code-block:: console
-
-        cd <dpdk directory>
-        export RTE_SDK=$PWD
-        export RTE_TARGET=build
-        cd examples/<application>
-        make -j
-
-meson build
-^^^^^^^^^^^
-
 .. code-block:: console
 
         meson build
@@ -529,17 +508,6 @@ Cross Compilation
 
 Refer to :doc:`../linux_gsg/cross_build_dpdk_for_arm64` for generic arm64 details.
 
-make build
-^^^^^^^^^^
-
-.. code-block:: console
-
-        make config T=arm64-octeontx2-linux-gcc
-        make -j CROSS=aarch64-marvell-linux-gnu- CONFIG_RTE_KNI_KMOD=n
-
-meson build
-^^^^^^^^^^^
-
 .. code-block:: console
 
         meson build --cross-file config/arm/arm64_octeontx2_linux_gcc
Signature · 1 line
2.28.0
Reviewed-by on v4 20/31
#189 lore raw

Re: [dpdk-dev] [PATCH v4 20/31] doc: remove references to make from platforms guides

Quoted 12 lines · Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
  doc/guides/platform/bluefield.rst | 22 ---------------------
  doc/guides/platform/octeontx.rst  | 33 +------------------------------
  doc/guides/platform/octeontx2.rst | 32 ------------------------------
  3 files changed, 1 insertion(+), 86 deletions(-)

[...]

#190 lore raw

PATCH v4 21/31 doc: remove references to make from mempool guide

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/mempool/octeontx.rst  | 28 +++-------------------------
 doc/guides/mempool/octeontx2.rst | 10 +---------
 2 files changed, 4 insertions(+), 34 deletions(-)
doc/guides/mempool/octeontx.rst +3 -25
index dfa1993e19..33c40d5b17 100644
@@ -30,33 +30,11 @@ Prerequisites
 
 See :doc: `../platform/octeontx.rst` for setup information.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``)
-
-  Set default mempool ops to octeontx_fpavf.
-
-- ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL`` (default ``y``)
-
-  Toggle compilation of the ``librte_mempool_octeontx`` driver.
 
 Driver Compilation
-~~~~~~~~~~~~~~~~~~
+------------------
 
-To compile the OCTEON TX FPAVF MEMPOOL PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-thunderx-linux-gcc
+See :doc:`../linux_gsg/build_dpdk` for more information on compiling DPDK.
 
 
 Initialization
@@ -70,5 +48,5 @@ Example:
 
 .. code-block:: console
 
-    ./build/app/test -c 0xf --base-virtaddr=0x100000000000 \
+    ./<build_dir>/app/test/dpdk-test -c 0xf --base-virtaddr=0x100000000000 \
                         --mbuf-pool-ops-name="octeontx_fpavf"
doc/guides/mempool/octeontx2.rst +1 -9
index 49b45a04e8..53f09a52db 100644
@@ -29,14 +29,6 @@ Prerequisites and Compilation procedure
 Pre-Installation Configuration
 ------------------------------
 
-Compile time Config Options
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following option can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL`` (default ``y``)
-
-  Toggle compilation of the ``librte_mempool_octeontx2`` driver.
 
 Runtime Config Options
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -97,4 +89,4 @@ Standalone mempool device
 
    Example command to run ``mempool_autotest`` test with standalone OCTEONTX2 NPA device::
 
-     echo "mempool_autotest" | build/app/test -c 0xf0 --mbuf-pool-ops-name="octeontx2_npa"
+     echo "mempool_autotest" | <build_dir>/app/test/dpdk-test -c 0xf0 --mbuf-pool-ops-name="octeontx2_npa"
Signature · 1 line
2.28.0
Reviewed-by on v4 21/31
#191 lore raw

Re: [dpdk-dev] [PATCH v4 21/31] doc: remove references to make from mempool guide

Quoted 11 lines · Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
  doc/guides/mempool/octeontx.rst  | 28 +++-------------------------
  doc/guides/mempool/octeontx2.rst | 10 +---------
  2 files changed, 4 insertions(+), 34 deletions(-)

[...]

#192 lore raw

PATCH v4 22/31 doc: remove references to make from NICs guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/nics/ark.rst            | 26 -------------
 doc/guides/nics/atlantic.rst       |  4 --
 doc/guides/nics/axgbe.rst          | 15 --------
 doc/guides/nics/bnx2x.rst          | 27 -------------
 doc/guides/nics/bnxt.rst           |  5 +--
 doc/guides/nics/build_and_test.rst |  8 +++-
 doc/guides/nics/cxgbe.rst          | 36 +++++------------
 doc/guides/nics/dpaa.rst           | 27 +------------
 doc/guides/nics/dpaa2.rst          | 26 +------------
 doc/guides/nics/ena.rst            | 16 --------
 doc/guides/nics/enetc.rst          |  2 -
 doc/guides/nics/enic.rst           |  9 -----
 doc/guides/nics/fail_safe.rst      | 20 ++--------
 doc/guides/nics/features.rst       |  9 -----
 doc/guides/nics/fm10k.rst          |  4 --
 doc/guides/nics/hinic.rst          |  9 -----
 doc/guides/nics/hns3.rst           | 10 -----
 doc/guides/nics/i40e.rst           | 44 ++++++---------------
 doc/guides/nics/ice.rst            | 25 ++----------
 doc/guides/nics/igc.rst            | 18 +--------
 doc/guides/nics/intel_vf.rst       | 13 +------
 doc/guides/nics/ionic.rst          |  8 ----
 doc/guides/nics/ipn3ke.rst         | 12 +-----
 doc/guides/nics/kni.rst            |  4 +-
 doc/guides/nics/liquidio.rst       | 27 -------------
 doc/guides/nics/memif.rst          | 10 ++---
 doc/guides/nics/mlx4.rst           | 55 ++------------------------
 doc/guides/nics/mlx5.rst           | 62 ++----------------------------
 doc/guides/nics/mvneta.rst         | 36 ++++-------------
 doc/guides/nics/mvpp2.rst          | 43 ++++-----------------
 doc/guides/nics/nfb.rst            | 19 +--------
 doc/guides/nics/nfp.rst            |  4 --
 doc/guides/nics/null.rst           |  6 +--
 doc/guides/nics/octeontx.rst       | 19 +--------
 doc/guides/nics/octeontx2.rst      | 13 +------
 doc/guides/nics/pcap_ring.rst      | 24 ++++++------
 doc/guides/nics/qede.rst           | 17 +-------
 doc/guides/nics/sfc_efx.rst        | 15 --------
 doc/guides/nics/softnic.rst        | 13 +------
 doc/guides/nics/szedata2.rst       | 18 +--------
 doc/guides/nics/thunderx.rst       | 25 +-----------
 doc/guides/nics/vdev_netvsc.rst    |  6 ---
 doc/guides/nics/vhost.rst          |  2 +-
 doc/guides/nics/virtio.rst         |  4 +-
 44 files changed, 102 insertions(+), 693 deletions(-)
doc/guides/nics/ark.rst +0 -26
index 06e8c33746..d7d679b452 100644
@@ -119,32 +119,6 @@ Data Path Interface
 Ingress RX and Egress TX operation is by the nominal DPDK API .
 The driver supports single-port, multi-queue for both RX and TX.
 
-Configuration Information
--------------------------
-
-**DPDK Configuration Parameters**
-
-  The following configuration options are available for the ARK PMD:
-
-   * **CONFIG_RTE_LIBRTE_ARK_PMD** (default y): Enables or disables inclusion
-     of the ARK PMD driver in the DPDK compilation.
-
-   * **CONFIG_RTE_LIBRTE_ARK_PAD_TX** (default y):  When enabled TX
-     packets are padded to 60 bytes to support downstream MACS.
-
-   * **CONFIG_RTE_LIBRTE_ARK_DEBUG_RX** (default n): Enables or disables debug
-     logging and internal checking of RX ingress logic within the ARK PMD driver.
-
-   * **CONFIG_RTE_LIBRTE_ARK_DEBUG_TX** (default n): Enables or disables debug
-     logging and internal checking of TX egress logic within the ARK PMD driver.
-
-   * **CONFIG_RTE_LIBRTE_ARK_DEBUG_STATS** (default n): Enables or disables debug
-     logging of detailed packet and performance statistics gathered in
-     the PMD and FPGA.
-
-   * **CONFIG_RTE_LIBRTE_ARK_DEBUG_TRACE** (default n): Enables or disables debug
-     logging of detailed PMD events and status.
-
 
 Building DPDK
 -------------
doc/guides/nics/atlantic.rst +0 -4
index 3f3f2949f3..605f6dc3ab 100644
@@ -26,10 +26,6 @@ Experimental API features
 
 - MACSEC PMD API is considered as experimental and is subject to change/removal in next DPDK releases.
 
-Configuration Information
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- ``CONFIG_RTE_LIBRTE_ATLANTIC_PMD`` (default ``y``)
 
 Application Programming Interface
 ---------------------------------
doc/guides/nics/axgbe.rst +0 -15
index 9b270a4226..10bf86fa54 100644
@@ -27,21 +27,6 @@ AXGBE PMD has support for:
 - Jumbo Frame up to 9K
 
 
-Configuration Information
--------------------------
-
-The following options can be modified in the ``.config`` file. Please note that
-enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_AXGBE_PMD`` (default **y**)
-
-  Toggle compilation of axgbe PMD.
-
-- ``CONFIG_RTE_LIBRTE_AXGBE_PMD_DEBUG`` (default **n**)
-
-  Toggle display for PMD debug related messages.
-
-
 Building DPDK
 -------------
 
doc/guides/nics/bnx2x.rst +0 -27
index ab90d8ae5e..3c163df7a8 100644
@@ -72,33 +72,6 @@ Prerequisites
   `linux-firmware git repository <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/plain/bnx2x/bnx2x-e2-7.13.11.0.fw>`_
   to get the required firmware.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``.config`` file. Please note that
-enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **n**)
-
-  Toggle compilation of bnx2x driver. To use bnx2x PMD set this config parameter
-  to 'y'. Also, in order for firmware binary to load user will need zlib devel
-  package installed.
-
-- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **n**)
-
-  Toggle display of transmit fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **n**)
-
-  Toggle display of receive fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **n**)
-
-  Toggle display of register reads and writes.
-
 
 .. _bnx2x_driver-compilation:
 
doc/guides/nics/bnxt.rst +1 -4
index 129a16cfc7..4b172fdaac 100644
@@ -565,9 +565,6 @@ The BNXT PMD supports a PTP client application to communicate with a PTP master
 clock using DPDK IEEE1588 APIs. Note that the PTP client application needs to
 run on PF and vector mode needs to be disabled.
 
-For the PTP time synchronization support, the BNXT PMD must be compiled with
-``CONFIG_RTE_LIBRTE_IEEE1588=y`` (this compilation flag is currently pending).
-
 .. code-block:: console
 
     testpmd> set fwd ieee1588 // enable IEEE 1588 mode
@@ -612,7 +609,7 @@ Basic stats include:
 * oerrors
 
 By default, per-queue stats for 16 queues are supported. For more than 16
-queues, BNXT PMD should be compiled with ``CONFIG_RTE_ETHDEV_QUEUE_STAT_CNTRS``
+queues, BNXT PMD should be compiled with ``RTE_ETHDEV_QUEUE_STAT_CNTRS``
 set to the desired number of queues.
 
 Extended Stats
doc/guides/nics/build_and_test.rst +6 -2
index 3138c0f880..03ce358553 100644
@@ -66,10 +66,14 @@ This section demonstrates how to setup and run ``testpmd`` in Linux.
 
 #. Load ``igb_uio`` or ``vfio-pci`` driver:
 
+   Before compiling, make sure to enable kmods for the meson build::
+
+      meson configure -Denable_kmods=true
+
    .. code-block:: console
 
       modprobe uio
-      insmod ./x86_64-native-linux-gcc/kmod/igb_uio.ko
+      insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
 
    or
 
@@ -106,7 +110,7 @@ This section demonstrates how to setup and run ``testpmd`` in Linux.
 
    .. code-block:: console
 
-      ./x86_64-native-linux-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
doc/guides/nics/cxgbe.rst +10 -26
index 54a4c13899..442ab1511c 100644
@@ -87,35 +87,19 @@ Prerequisites
   :ref:`linux-installation` for Linux and section :ref:`freebsd-installation`
   for FreeBSD.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``.config`` file. Please note that
-enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_CXGBE_PMD`` (default **y**)
-
-  Toggle compilation of librte_pmd_cxgbe driver.
-
-  .. note::
-
-     This controls compilation of both CXGBE and CXGBEVF PMD.
 
 Runtime Options
-~~~~~~~~~~~~~~~
+---------------
 
 The following ``devargs`` options can be enabled at runtime. They must
 be passed as part of EAL arguments. For example,
 
 .. code-block:: console
 
-   testpmd -w 02:00.4,keep_ovlan=1 -- -i
+   dpdk-testpmd -w 02:00.4,keep_ovlan=1 -- -i
 
 Common Runtime Options
-^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~
 
 - ``keep_ovlan`` (default **0**)
 
@@ -133,7 +117,7 @@ Common Runtime Options
   coalesce limit has been reached.
 
 CXGBE VF Only Runtime Options
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - ``force_link_up`` (default **0**)
 
@@ -142,7 +126,7 @@ CXGBE VF Only Runtime Options
   to send traffic to each other even when the physical link is down.
 
 CXGBE PF Only Runtime Options
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - ``filtermode`` (default **0**)
 
@@ -317,7 +301,7 @@ CXGBE PF Only Runtime Options
 
   .. code-block:: console
 
-     testpmd -w 02:00.4,filtermode=0x88 -- -i
+     dpdk-testpmd -w 02:00.4,filtermode=0x88 -- -i
 
 - ``filtermask`` (default **0**)
 
@@ -344,7 +328,7 @@ CXGBE PF Only Runtime Options
 
   .. code-block:: console
 
-     testpmd -w 02:00.4,filtermode=0x88,filtermask=0x80 -- -i
+     dpdk-testpmd -w 02:00.4,filtermode=0x88,filtermask=0x80 -- -i
 
 .. _driver-compilation:
 
@@ -689,7 +673,7 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system.
 
    .. code-block:: console
 
-      cp x86_64-native-freebsd-clang/kmod/contigmem.ko /boot/kernel/
+      cp <build_dir>/kernel/freebsd/contigmem.ko /boot/kernel/
 
 #. Add the following lines to /boot/loader.conf:
 
@@ -770,13 +754,13 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system.
 
    .. code-block:: console
 
-      kldload ./x86_64-native-freebsd-clang/kmod/nic_uio.ko
+      kldload <build_dir>/kernel/freebsd/nic_uio.ko
 
 #. Start testpmd with basic parameters:
 
    .. code-block:: console
 
-      ./x86_64-native-freebsd-clang/app/testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i
+      ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i
 
    Example output:
 
doc/guides/nics/dpaa.rst +1 -26
index 17839a920e..eba8bfe600 100644
@@ -195,31 +195,6 @@ See :doc:`../platform/dpaa` for setup information
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_DPAA_BUS`` (default ``y``)
-
-  Toggle compilation of the ``librte_bus_dpaa`` driver.
-
-- ``CONFIG_RTE_LIBRTE_DPAA_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_dpaa`` driver.
-
-- ``CONFIG_RTE_LIBRTE_DPAA_DEBUG_DRIVER`` (default ``n``)
-
-  Toggles display of bus configurations and enables a debugging queue
-  to fetch error (Rx/Tx) packets to driver. By default, packets with errors
-  (like wrong checksum) are dropped by the hardware.
-
-- ``CONFIG_RTE_LIBRTE_DPAA_HWDEBUG`` (default ``n``)
-
-  Enables debugging of the Queue and Buffer Manager layer which interacts
-  with the DPAA hardware.
-
 
 Environment Variables
 ~~~~~~~~~~~~~~~~~~~~~
@@ -264,7 +239,7 @@ for details.
 
    .. code-block:: console
 
-      ./arm64-dpaa-linux-gcc/testpmd -c 0xff -n 1 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 1 \
         -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx
 
       .....
doc/guides/nics/dpaa2.rst +1 -25
index fdfa6fdd5a..b64bc6311b 100644
@@ -432,30 +432,6 @@ Currently supported by DPDK:
    Some part of fslmc bus code (mc flib - object library) routines are
    dual licensed (BSD & GPLv2), however they are used as BSD in DPDK in userspace.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_FSLMC_BUS`` (default ``y``)
-
-  Toggle compilation of the ``librte_bus_fslmc`` driver.
-
-- ``CONFIG_RTE_LIBRTE_DPAA2_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_dpaa2`` driver.
-
-- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_DRIVER`` (default ``n``)
-
-  Toggle display of debugging messages/logic
-
-- ``CONFIG_RTE_LIBRTE_DPAA2_USE_PHYS_IOVA`` (default ``n``)
-
-  Toggle to use physical address vs virtual address for hardware accelerators.
 
 Driver compilation and testing
 ------------------------------
@@ -473,7 +449,7 @@ for details.
 
    .. code-block:: console
 
-      ./testpmd -c 0xff -n 1 -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx
+      ./dpdk-testpmd -c 0xff -n 1 -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx
 
       .....
       EAL: Registered [pci] bus.
doc/guides/nics/ena.rst +0 -16
index bec97c3326..4bdc3182fc 100644
@@ -79,22 +79,6 @@ The driver supports multi-queue for both Tx and Rx.
 Configuration information
 -------------------------
 
-**DPDK Configuration Parameters**
-
-  The following configuration options are available for the ENA PMD:
-
-   * **CONFIG_RTE_LIBRTE_ENA_PMD** (default y): Enables or disables inclusion
-     of the ENA PMD driver in the DPDK compilation.
-
-   * **CONFIG_RTE_LIBRTE_ENA_DEBUG_RX** (default n): Enables or disables debug
-     logging of RX logic within the ENA PMD driver.
-
-   * **CONFIG_RTE_LIBRTE_ENA_DEBUG_TX** (default n): Enables or disables debug
-     logging of TX logic within the ENA PMD driver.
-
-   * **CONFIG_RTE_LIBRTE_ENA_COM_DEBUG** (default n): Enables or disables debug
-     logging of low level tx/rx logic in ena_com(base) within the ENA PMD driver.
-
 **Runtime Configuration Parameters**
 
    * **large_llq_hdr** (default 0)
doc/guides/nics/enetc.rst +0 -2
index 3c896eeffa..6203f4d799 100644
@@ -113,5 +113,3 @@ Driver compilation and testing
 Follow instructions available in the document
 :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 to launch **testpmd**
-
-To compile in performance mode, please set ``CONFIG_RTE_CACHE_LINE_SIZE=64``
doc/guides/nics/enic.rst +0 -9
index a28a7f4e47..be6a034279 100644
@@ -20,13 +20,6 @@ should be downloaded from https://core.dpdk.org/download/
 Configuration information
 -------------------------
 
-- **DPDK Configuration Parameters**
-
-  The following configuration options are available for the ENIC PMD:
-
-  - **CONFIG_RTE_LIBRTE_ENIC_PMD** (default y): Enables or disables inclusion
-    of the ENIC PMD driver in the DPDK compilation.
-
 - **vNIC Configuration Parameters**
 
   - **Number of Queues**
@@ -583,8 +576,6 @@ The value depends on the memory configuration of the application, DPDK and
 PMD.  Typically, the limit has to be raised to higher than 2GB.
 e.g., 2621440
 
-The compilation of any unused drivers can be disabled using the
-configuration file in config/ directory (e.g., config/common_linux).
 This would help in bringing down the time taken for building the
 libraries and the initialization time of the application.
 
doc/guides/nics/fail_safe.rst +4 -16
index b4a92f663b..b7bc5a566b 100644
@@ -14,10 +14,6 @@ Additionally to the Seamless Hotplug feature, the Fail-safe PMD offers the
 ability to redirect operations to a secondary device when the primary has been
 removed from the system.
 
-.. note::
-
-   The library is enabled by default. You can enable it or disable it manually
-   by setting the ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` configuration option.
 
 Features
 --------
@@ -33,14 +29,6 @@ automatically by detecting capable devices and registering the relevant handler.
 
 Check the feature matrix for the complete set of supported features.
 
-Compilation option
-------------------
-
-Available options within the ``$RTE_TARGET/build/.config`` file:
-
-- ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` (default **y**)
-
-  This option enables or disables compiling librte_pmd_failsafe.
 
 Using the Fail-safe PMD from the EAL command line
 -------------------------------------------------
@@ -128,7 +116,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
 
    .. code-block:: console
 
-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \
          --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
          -b 84:00.0 -b 00:04.0 -- -i
 
@@ -142,7 +130,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
 
    .. code-block:: console
 
-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \
          --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
          -w 81:00.0 -- -i
 
@@ -150,7 +138,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
 
    .. code-block:: console
 
-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 -w ff:ff.f \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 -w ff:ff.f \
          --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i
 
 #. Start testpmd, automatically probing the device 84:00.0 and using it with
@@ -158,7 +146,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
  
    .. code-block:: console
  
-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \
          --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i
 
 
doc/guides/nics/features.rst +0 -9
index edd21c4d8e..6172a0fa4b 100644
@@ -812,8 +812,6 @@ ARMv7
 
 Support armv7 architecture.
 
-Use ``defconfig_arm-armv7a-*-*``.
-
 
 .. _nic_features_armv8:
 
@@ -822,8 +820,6 @@ ARMv8
 
 Support armv8a (64bit) architecture.
 
-Use ``defconfig_arm64-armv8a-*-*``
-
 
 .. _nic_features_power8:
 
@@ -832,7 +828,6 @@ Power8
 
 Support PowerPC architecture.
 
-Use ``defconfig_ppc_64-power8-*-*``
 
 .. _nic_features_x86-32:
 
@@ -841,8 +836,6 @@ x86-32
 
 Support 32bits x86 architecture.
 
-Use ``defconfig_x86_x32-native-*-*`` and ``defconfig_i686-native-*-*``.
-
 
 .. _nic_features_x86-64:
 
@@ -851,8 +844,6 @@ x86-64
 
 Support 64bits x86 architecture.
 
-Use ``defconfig_x86_64-native-*-*``.
-
 
 .. _nic_features_usage_doc:
 
doc/guides/nics/fm10k.rst +0 -4
index 4e178c2cc6..0f7c91bbd1 100644
@@ -35,10 +35,6 @@ There is no change to the PMD API. The RX/TX handlers are the only two entries f
 vPMD packet I/O. They are transparently registered at runtime RX/TX execution
 if all required conditions are met.
 
-1.  To date, only an SSE version of FM10K vPMD is available.
-    To ensure that vPMD is in the binary code, set
-    ``CONFIG_RTE_LIBRTE_FM10K_INC_VECTOR=y`` in the configure file.
-
 Some constraints apply as pre-conditions for specific optimizations on bulk
 packet transfers. The following sections explain RX and TX constraints in the
 vPMD.
doc/guides/nics/hinic.rst +0 -9
index f765060641..fe13c582e7 100644
@@ -46,15 +46,6 @@ Prerequisites
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_HINIC_PMD`` (default ``y``)
 
 Driver compilation and testing
 ------------------------------
doc/guides/nics/hns3.rst +0 -10
index a62fcfdede..d96ad5d445 100644
@@ -44,16 +44,6 @@ Prerequisites
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_HNS3_PMD`` (default ``y``)
 
 Driver compilation and testing
 ------------------------------
doc/guides/nics/i40e.rst +12 -32

84 lines not on this page · raw message

doc/guides/nics/ice.rst +4 -21
index 9a9f4a6bb0..9d3fcd1c9c 100644
@@ -23,23 +23,6 @@ Prerequisites
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_ICE_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_ice`` driver.
-
-- ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``)
-
-  Toggle display of generic debugging messages.
-
-- ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``)
-
-  Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
 
 Runtime Config Options
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -106,14 +89,14 @@ Runtime Config Options
 
   .. code-block:: console
 
-    testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
+    dpdk-testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
 
   This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are
   VLAN extraction, other queues run with no protocol extraction.
 
   .. code-block:: console
 
-    testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
+    dpdk-testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
 
   This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are
   IPv6 extraction, other queues use the default VLAN extraction.
@@ -253,7 +236,7 @@ responses for the same from PF.
 
 #. Bind the VF0,  and run testpmd with 'cap=dcf' devarg::
 
-      testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i
+      dpdk-testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i
 
 #. Monitor the VF2 interface network traffic::
 
@@ -282,7 +265,7 @@ To start ``testpmd``, and add vlan 10 to port 0:
 
 .. code-block:: console
 
-    ./app/testpmd -l 0-15 -n 4 -- -i
+    ./app/dpdk-testpmd -l 0-15 -n 4 -- -i
     ...
 
     testpmd> rx_vlan add 10 0
doc/guides/nics/igc.rst +2 -16
index 4c5e626759..3b096236bf 100644
@@ -11,20 +11,6 @@ I225 Series Network Adapters.
   `https://ark.intel.com/content/www/us/en/ark/products/series/184686/
   intel-ethernet-controller-i225-series.html`
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_IGC_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_igc`` driver.
-
-- ``CONFIG_RTE_LIBRTE_IGC_DEBUG_*`` (default ``n``)
-
-  Toggle display of generic debugging messages.
-
 
 Driver compilation and testing
 ------------------------------
@@ -67,7 +53,7 @@ outer VLAN to 0x9100:
 
 .. code-block:: console
 
-   ./app/testpmd -l 4-8 -- -i
+   ./app/dpdk-testpmd -l 4-8 -- -i
    ...
 
    testpmd> vlan set filter on 0
@@ -94,7 +80,7 @@ Start ``testpmd``:
 
 .. code-block:: console
 
-   ./testpmd -l 4-8 -- i --rxq=4 --txq=4 --pkt-filter-mode=perfect --disable-rss
+   ./dpdk-testpmd -l 4-8 -- i --rxq=4 --txq=4 --pkt-filter-mode=perfect --disable-rss
 
 Add a rule to direct packet whose ``ether-type=0x801`` to queue 1:
 
doc/guides/nics/intel_vf.rst +2 -11
index ade5152595..723a9c0fa2 100644
@@ -124,7 +124,6 @@ Intel® X710/XL710 Gigabit Ethernet Controller VF Infrastructure
 
 In a virtualized environment, the programmer can enable a maximum of *128 Virtual Functions (VF)*
 globally per Intel® X710/XL710 Gigabit Ethernet Controller NIC device.
-The number of queue pairs of each VF can be configured by ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VF`` in ``config`` file.
 The Physical Function in host could be either configured by the Linux* i40e driver
 (in the case of the Linux Kernel-based Virtual Machine [KVM]) or by DPDK PMD PF driver.
 When using both DPDK PMD PF/VF drivers, the whole NIC will be taken over by DPDK based application.
@@ -521,20 +520,12 @@ The setup procedure is as follows:
 
     .. code-block:: console
 
-        make install T=x86_64-native-linux-gcc
-        ./x86_64-native-linux-gcc/app/testpmd -l 0-3 -n 4 -- -i
+        ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i
 
 #.  Finally, access the Guest OS using vncviewer with the localhost:5900 port and check the lspci command output in the Guest OS.
     The virtual functions will be listed as available for use.
 
-#.  Configure and install the DPDK with an x86_64-native-linux-gcc configuration on the Guest OS as normal,
-    that is, there is no change to the normal installation procedure.
-
-    .. code-block:: console
-
-        make config T=x86_64-native-linux-gcc O=x86_64-native-linux-gcc
-        cd x86_64-native-linux-gcc
-        make
+#.  Configure and install the DPDK on the Guest OS as normal, that is, there is no change to the normal installation procedure.
 
 .. note::
 
doc/guides/nics/ionic.rst +0 -8
index 787123df5d..fd32926bf4 100644
@@ -24,14 +24,6 @@ on the host, check for the PCI devices:
       b5:00.0 Ethernet controller: Device 1dd8:1002
       b6:00.0 Ethernet controller: Device 1dd8:1002
 
-Pre-Installation Configuration
-------------------------------
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_IONIC_PMD`` (default ``y``)
-
-  Toggle compilation of ionic PMD.
 
 Building DPDK
 -------------
doc/guides/nics/ipn3ke.rst +2 -10
index c6c1552f66..5d4534e4da 100644
@@ -31,14 +31,6 @@ Prerequisites
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_IPN3KE_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_ipn3ke`` driver.
 
 Runtime Config Options
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -85,7 +77,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port:
 
 .. code-block:: console
 
-    ./app/testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop
+    ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop
 
 HQoS and flow acceleration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -96,7 +88,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port, enable FPGA HQoS and
 
 .. code-block:: console
 
-    ./app/testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap
+    ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap
 
 Limitations or Known issues
 ---------------------------
doc/guides/nics/kni.rst +2 -2
index 90d3040cf5..80ba459d49 100644
@@ -97,13 +97,13 @@ It is possible to test PMD quickly using KNI kernel module loopback feature:
 
     .. code-block:: console
 
-        insmod build/kmod/rte_kni.ko lo_mode=lo_mode_fifo_skb
+        insmod <build_dir>/kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo_skb
 
 * Start testpmd with no physical device but two KNI virtual devices:
 
     .. code-block:: console
 
-        ./testpmd --vdev net_kni0 --vdev net_kni1 -- -i
+        ./dpdk-testpmd --vdev net_kni0 --vdev net_kni1 -- -i
 
     .. code-block:: console
 
doc/guides/nics/liquidio.rst +0 -27
index 0534146720..65c7d2d0b0 100644
@@ -20,33 +20,6 @@ Supported LiquidIO Adapters
 - LiquidIO II CN2360 210SVPT
 
 
-Pre-Installation Configuration
-------------------------------
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_LIO_PMD`` (default ``y``)
-
-  Toggle compilation of LiquidIO PMD.
-
-- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_RX`` (default ``n``)
-
-  Toggle display of receive fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_TX`` (default ``n``)
-
-  Toggle display of transmit fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_MBOX`` (default ``n``)
-
-  Toggle display of mailbox messages.
-
-- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_REGS`` (default ``n``)
-
-  Toggle display of register reads and writes.
-
-
 SR-IOV: Prerequisites and Sample Application Notes
 --------------------------------------------------
 
doc/guides/nics/memif.rst +5 -5
index ddeebed25c..6c6227f979 100644
@@ -213,15 +213,15 @@ In this example we run two instances of testpmd application and transmit packets
 
 First create ``master`` interface::
 
-    #./build/app/testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=master -- -i
+    #./<build_dir>/app/dpdk-testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=master -- -i
 
 Now create ``slave`` interface (master must be already running so the slave will connect)::
 
-    #./build/app/testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i
+    #./<build_dir>/app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i
 
 You can also enable ``zero-copy`` on ``slave`` interface::
 
-    #./build/app/testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i
+    #./<build_dir>/app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i
 
 Start forwarding packets::
 
@@ -257,7 +257,7 @@ To see socket filename use show memif command::
 
 Now create memif interface by running testpmd with these command line options::
 
-    #./testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i
+    #./dpdk-testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i
 
 Testpmd should now create memif slave interface and try to connect to master.
 In testpmd set forward option to icmpecho and start forwarding::
@@ -280,7 +280,7 @@ The situation is analogous to cross connecting 2 ports of the NIC by cable.
 
 To set the loopback, just use the same socket and id with different roles::
 
-    #./testpmd --vdev=net_memif0,role=master,id=0 --vdev=net_memif1,role=slave,id=0 -- -i
+    #./dpdk-testpmd --vdev=net_memif0,role=master,id=0 --vdev=net_memif1,role=slave,id=0 -- -i
 
 Then start the communication::
 
doc/guides/nics/mlx4.rst +3 -52

79 lines not on this page · raw message

doc/guides/nics/mlx5.rst +3 -59

86 lines not on this page · raw message

doc/guides/nics/mvneta.rst +8 -28
index c8b00ddf22..e8abde42da 100644
@@ -13,12 +13,6 @@ Detailed information about SoCs that use PPv2 can be obtained here:
 
 * https://www.marvell.com/embedded-processors/armada-3700/
 
-.. Note::
-
-   Due to external dependencies, this driver is disabled by default. It must
-   be enabled manually by setting relevant configuration option manually.
-   Please refer to `Config File Options`_ section for further details.
-
 
 Features
 --------
@@ -81,20 +75,9 @@ Prerequisites
   Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
   DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_MVNETA_PMD`` (default ``n``)
-
-    Toggle compilation of the librte_pmd_mvneta driver.
 
 Runtime options
-~~~~~~~~~~~~~~~
+---------------
 
 The following ``devargs`` options can be enabled at runtime. They must
 be passed as part of EAL arguments.
@@ -107,7 +90,7 @@ be passed as part of EAL arguments.
 
 .. code-block:: console
 
-   ./testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 \
+   ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 \
     -c 3 -- -i --p 3 -a
 
 
@@ -126,16 +109,13 @@ Driver needs precompiled MUSDK library during compilation.
 MUSDK will be installed to `usr/local` under current directory.
 For the detailed build instructions please consult ``doc/musdk_get_started.txt``.
 
-Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` with
-the path to the MUSDK installation directory needs to be exported.
+The path to the MUSDK installation directory needs to set in meson, shown in the
+following command:
 
 .. code-block:: console
 
-   export LIBMUSDK_PATH=<musdk>/usr/local
-   export CROSS=aarch64-linux-gnu-
-   make config T=arm64-armv8a-linux-gcc
-   sed -ri 's,(MVNETA_PMD=)n,\1y,' build/.config
-   make
+   meson -Dlib_musdk_dir=/path/to/musdk build ninja -C build
+
 
 Usage Example
 -------------
@@ -160,7 +140,7 @@ In order to run testpmd example application following command can be used:
 
 .. code-block:: console
 
-   ./testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- \
+   ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- \
      -i --p 3 -a --txd 256 --rxd 128 --rxq=1 --txq=1  --nb-cores=1
 
 
@@ -168,4 +148,4 @@ In order to run l2fwd example application following command can be used:
 
 .. code-block:: console
 
-   ./l2fwd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- -T 1 -p 3
+   ./dpdk-l2fwd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- -T 1 -p 3
doc/guides/nics/mvpp2.rst +8 -35

97 lines not on this page · raw message

doc/guides/nics/nfb.rst +2 -17
index 10f33a025e..ecea3ecff0 100644
@@ -16,13 +16,6 @@ and used technology
 (`Netcope Development Kit <http://www.netcope.com/en/products/fpga-development-kit>`_)
 can be found on the `Netcope Technologies website <http://www.netcope.com/>`_.
 
-.. note::
-
-   This driver has external dependencies.
-   Therefore it is disabled in default configuration files.
-   It can be enabled by setting ``CONFIG_RTE_LIBRTE_NFB_PMD=y``
-   and recompiling.
-
 .. note::
 
    Currently the driver is supported only on x86_64 architectures.
@@ -62,14 +55,6 @@ The minimum version of the provided packages:
 Configuration
 -------------
 
-These configuration options can be modified before compilation in the
-``.config`` file:
-
-*  ``CONFIG_RTE_LIBRTE_NFB_PMD`` default value: **n**
-
-   Value **y** enables compilation of nfb PMD.
-
-
 Timestamps
 
 The PMD supports hardware timestamps of frame receipt on physical network interface. In order to use
@@ -78,7 +63,7 @@ products) and the device argument `timestamp=1` must be used.
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params>
+    ./<build_dir>/app/dpdk-testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params>
 
 When the timestamps are enabled with the *devarg*, a timestamp validity flag is set in the MBUFs
 containing received frames and timestamp is inserted into the `rte_mbuf` struct.
@@ -133,7 +118,7 @@ transmit queue:
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 2 \
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 2 \
    -- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2 -i -a
 
 Example output:
doc/guides/nics/nfp.rst +0 -4
index 5f2a0698f6..6aa58f4358 100644
@@ -49,10 +49,6 @@ compile it along with other DPDK PMDs even if no BSP was installed previously.
 Of course, a DPDK app will require such a BSP installed for using the
 NFP PMD, along with a specific NFP firmware application.
 
-Default PMD configuration is at the **common_linux configuration** file:
-
-- **CONFIG_RTE_LIBRTE_NFP_PMD=y**
-
 Once the DPDK is built all the DPDK apps and examples include support for
 the NFP PMD.
 
doc/guides/nics/null.rst +3 -3
index c68d0d6051..e75abd96d2 100644
@@ -14,7 +14,7 @@ Usage
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i
 
 
 Runtime Config Options
@@ -26,7 +26,7 @@ Runtime Config Options
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i
 
 - ``size`` [optional, default=64 bytes]
 
@@ -35,7 +35,7 @@ Runtime Config Options
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i
 
 - ``no-rx`` [optional, default disabled]
 
doc/guides/nics/octeontx.rst +1 -18
index c8655bf375..c01ae09bb3 100644
@@ -52,15 +52,6 @@ See :doc:`../platform/octeontx` for setup information.
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_OCTEONTX_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_octeontx`` driver.
 
 Driver compilation and testing
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -68,14 +59,6 @@ Driver compilation and testing
 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 for details.
 
-To compile the OCTEON TX PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-thunderx-linux-gcc install
-
 #. Running testpmd:
 
    Follow instructions available in the document
@@ -86,7 +69,7 @@ following ``make`` command:
 
    .. code-block:: console
 
-      ./arm64-thunderx-linux-gcc/app/testpmd -c 700 \
+      ./<build_dir>/app/dpdk-testpmd -c 700 \
                 --base-virtaddr=0x100000000000 \
                 --mbuf-pool-ops-name="octeontx_fpavf" \
                 --vdev='event_octeontx' \
doc/guides/nics/octeontx2.rst +1 -12
index bb591a8b7e..903b52b802 100644
@@ -46,14 +46,6 @@ Prerequisites
 
 See :doc:`../platform/octeontx2` for setup information.
 
-Compile time Config Options
----------------------------
-
-The following options may be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_OCTEONTX2_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_octeontx2`` driver.
 
 Driver compilation and testing
 ------------------------------
@@ -61,9 +53,6 @@ Driver compilation and testing
 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 for details.
 
-To compile the OCTEON TX2 PMD for Linux arm64 gcc,
-use arm64-octeontx2-linux-gcc as target.
-
 #. Running testpmd:
 
    Follow instructions available in the document
@@ -74,7 +63,7 @@ use arm64-octeontx2-linux-gcc as target.
 
    .. code-block:: console
 
-      ./build/app/testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1
+      ./<build_dir>/app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1
       EAL: Detected 24 lcore(s)
       EAL: Detected 1 NUMA nodes
       EAL: Multi-process socket /var/run/dpdk/rte/mp_socket
doc/guides/nics/pcap_ring.rst +11 -13
index cf230ae40a..67bd23ea4a 100644
@@ -15,10 +15,8 @@ the DPDK also includes pure-software PMDs, two of these drivers are:
 
 .. note::
 
-    The libpcap -based PMD is disabled by default in the build configuration files,
-    owing to an external dependency on the libpcap development files which must be installed on the board.
-    Once the libpcap development files are installed,
-    the library can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK.
+    The libpcap -based PMD has an external dependency on the libpcap development files which must
+    be installed on the board.
 
 Using the Drivers from the EAL Command Line
 -------------------------------------------
@@ -42,7 +40,7 @@ Device name and stream options must be separated by commas as shown below:
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
        --vdev 'net_pcap0,stream_opt0=..,stream_opt1=..' \
        --vdev='net_pcap1,stream_opt0=..'
 
@@ -141,7 +139,7 @@ Read packets from one pcap file and write them to another:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \
         -- --port-topology=chained
 
@@ -149,7 +147,7 @@ Read packets from a network interface and write them to a pcap file:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_iface=eth0,tx_pcap=file_tx.pcap' \
         -- --port-topology=chained
 
@@ -157,7 +155,7 @@ Read packets from a pcap file and write them to a network interface:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_iface=eth1' \
         -- --port-topology=chained
 
@@ -165,14 +163,14 @@ Forward packets through two network interfaces:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,iface=eth0' --vdev='net_pcap1;iface=eth1'
 
 Enable 2 tx queues on a network interface:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_iface=eth1,tx_iface=eth1,tx_iface=eth1' \
         -- --txq 2
 
@@ -180,7 +178,7 @@ Read only incoming packets from a network interface and write them back to the s
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_iface_in=eth1,tx_iface=eth1'
 
 Using libpcap-based PMD with the testpmd Application
@@ -205,7 +203,7 @@ Otherwise, the first 512 packets from the input pcap file will be discarded by t
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \
         -- --port-topology=chained --no-flush-rx
 
@@ -225,7 +223,7 @@ Multiple devices may be specified, separated by commas.
 
 .. code-block:: console
 
-    ./testpmd -l 1-3 -n 4 --vdev=net_ring0 --vdev=net_ring1 -- -i
+    ./dpdk-testpmd -l 1-3 -n 4 --vdev=net_ring0 --vdev=net_ring1 -- -i
     EAL: Detected lcore 1 as core 1 on socket 0
     ...
 
doc/guides/nics/qede.rst +2 -15
index 5b2f868952..6df0066dd4 100644
@@ -111,22 +111,9 @@ Performance note
 Config File Options
 ~~~~~~~~~~~~~~~~~~~
 
-The following options can be modified in the ``.config`` file. Please note that
-enabling debugging options may affect system performance.
+The following option can be modified in the ``config/rte_config.h`` file.
 
-- ``CONFIG_RTE_LIBRTE_QEDE_PMD`` (default **y**)
-
-  Toggle compilation of QEDE PMD driver.
-
-- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_TX`` (default **n**)
-
-  Toggle display of transmit fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_RX`` (default **n**)
-
-  Toggle display of receive fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_QEDE_FW`` (default **""**)
+- ``RTE_LIBRTE_QEDE_FW`` (default **""**)
 
   Gives absolute path of firmware file.
   ``Eg: "/lib/firmware/qed/qed_init_values-8.40.33.0.bin"``
doc/guides/nics/sfc_efx.rst +0 -15
index be1c2fe1d6..6ee5190f3c 100644
@@ -271,21 +271,6 @@ Pre-Installation Configuration
 ------------------------------
 
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``.config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
-
-  Enable compilation of Solarflare libefx-based poll-mode driver.
-
-- ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
-
-  Enable compilation of the extra run-time consistency checks.
-
-
 Per-Device Parameters
 ~~~~~~~~~~~~~~~~~~~~~
 
doc/guides/nics/softnic.rst +2 -11
index 8f0dd53eac..695ebed91f 100644
@@ -51,15 +51,6 @@ Any Linux distribution fulfilling the conditions described in ``System Requireme
 section of :ref:`the DPDK documentation <linux_gsg>` or refer to *DPDK
 Release Notes*.
 
-Build options
--------------
-
-The default PMD configuration available in the common_linux configuration file:
-
-CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y
-
-Once the DPDK is built, all the DPDK applications include support for the
-Soft NIC PMD.
 
 Soft NIC PMD arguments
 ----------------------
@@ -130,7 +121,7 @@ Soft NIC testing
 
     .. code-block:: console
 
-         ./testpmd -c 0x7 -s 0x4 --vdev 'net_softnic0,firmware=<script path>/firmware.cli,cpu_id=0,conn_port=8086' -- -i
+         ./dpdk-testpmd -c 0x7 -s 0x4 --vdev 'net_softnic0,firmware=<script path>/firmware.cli,cpu_id=0,conn_port=8086' -- -i
               --portmask=0x2
 
     .. code-block:: console
@@ -375,7 +366,7 @@ commands.
 
     .. code-block:: console
 
-        ./x86_64-native-linux-gcc/app/testpmd -c 0x7 -s 0x4 -n 4 \
+        ./<build_dir>/app/dpdk-testpmd -c 0x7 -s 0x4 -n 4 \
                                     --vdev 'net_softnic0, \
                                     firmware=./drivers/net/softnic/ \
                                         firmware.cli, \
doc/guides/nics/szedata2.rst +1 -17
index 30710a80b8..9cf3f39eb5 100644
@@ -15,13 +15,6 @@ and used technology
 (`Netcope Development Kit <http://www.netcope.com/en/products/fpga-development-kit>`_)
 can be found on the `Netcope Technologies website <http://www.netcope.com/>`_.
 
-.. note::
-
-   This driver has external dependencies.
-   Therefore it is disabled in default configuration files.
-   It can be enabled by setting ``CONFIG_RTE_LIBRTE_PMD_SZEDATA2=y``
-   and recompiling.
-
 .. note::
 
    Currently the driver is supported only on x86_64 architectures.
@@ -63,15 +56,6 @@ The minimum version of the provided packages:
 
 * for DPDK up to 18.02 (including): **3.0.5**
 
-Configuration
--------------
-
-These configuration options can be modified before compilation in the
-``.config`` file:
-
-*  ``CONFIG_RTE_LIBRTE_PMD_SZEDATA2`` default value: **n**
-
-   Value **y** enables compilation of szedata2 PMD.
 
 Using the SZEDATA2 PMD
 ----------------------
@@ -129,7 +113,7 @@ transmit channel:
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 2 \
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 2 \
    -- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2 -i -a
 
 Example output:
doc/guides/nics/thunderx.rst +2 -23
index b1ef9eba59..a928a790e3 100644
@@ -43,26 +43,6 @@ Prerequisites
 -------------
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_thunderx_nicvf`` driver.
-
-- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_RX`` (default ``n``)
-
-  Toggle asserts of receive fast path.
-
-- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_TX`` (default ``n``)
-
-  Toggle asserts of transmit fast path.
 
 Driver compilation and testing
 ------------------------------
@@ -70,8 +50,7 @@ Driver compilation and testing
 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 for details.
 
-To compile the ThunderX NICVF PMD for Linux arm64 gcc,
-use arm64-thunderx-linux-gcc as target.
+Use config/arm/arm64-thunderx-linux-gcc as a meson cross-file when cross-compiling.
 
 Linux
 -----
@@ -178,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS.
 
    .. code-block:: console
 
-      ./arm64-thunderx-linux-gcc/app/testpmd -l 0-3 -n 4 -w 0002:01:00.2 \
+      ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0002:01:00.2 \
         -- -i --no-flush-rx \
         --port-topology=loop
 
doc/guides/nics/vdev_netvsc.rst +0 -6
index d1da071187..d9f6319b9f 100644
@@ -61,12 +61,6 @@ This driver implementation may be temporary and should be improved or removed
 either when hot-plug will be fully supported in EAL and bus drivers or when
 a new NetVSC driver will be integrated.
 
-Build options
--------------
-
-- ``CONFIG_RTE_LIBRTE_VDEV_NETVSC_PMD`` (default ``y``)
-
-   Toggle compilation of this driver.
 
 Run-time parameters
 -------------------
doc/guides/nics/vhost.rst +1 -1
index d36f3120b2..ee802ec4a8 100644
@@ -90,7 +90,7 @@ This section demonstrates vhost PMD with testpmd DPDK sample application.
 
     .. code-block:: console
 
-        ./testpmd -l 0-3 -n 4 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i
+        ./dpdk-testpmd -l 0-3 -n 4 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i
 
     Other basic DPDK preparations like hugepage enabling here.
     Please refer to the *DPDK Getting Started Guide* for detailed instructions.
doc/guides/nics/virtio.rst +2 -2
index 0daf25b22d..a51b389685 100644
@@ -110,7 +110,7 @@ Host2VM communication example
 
     .. code-block:: console
 
-        examples/kni/build/app/kni -l 0-3 -n 4 -- -p 0x1 -P --config="(0,1,3)"
+        <build_dir>/examples/dpdk-kni -l 0-3 -n 4 -- -p 0x1 -P --config="(0,1,3)"
 
     This command generates one network device vEth0 for physical port.
     If specify more physical ports, the generated network device will be vEth1, vEth2, and so on.
@@ -340,7 +340,7 @@ Here we use l3fwd-power as an example to show how to get started.
 
     .. code-block:: console
 
-        $ l3fwd-power -l 0-1 -- -p 1 -P --config="(0,0,1)" \
+        $ dpdk-l3fwd-power -l 0-1 -- -p 1 -P --config="(0,0,1)" \
                                                --no-numa --parse-ptype
 
 
Signature · 1 line
2.28.0
#193 lore raw

PATCH v4 23/31 doc: remove references to make from vdpadevs guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/vdpadevs/ifc.rst  | 13 ------------
 doc/guides/vdpadevs/mlx5.rst | 40 +++---------------------------------
 2 files changed, 3 insertions(+), 50 deletions(-)
doc/guides/vdpadevs/ifc.rst +0 -13
index 12a2a342e6..f968489a75 100644
@@ -11,19 +11,6 @@ directly by DMA. Besides, it supports dirty page logging and device state
 report/restore, this driver enables its vDPA functionality.
 
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following option can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_IFC_PMD`` (default ``y`` for linux)
-
-  Toggle compilation of the ``librte_pmd_ifc`` driver.
-
-
 IFCVF vDPA Implementation
 -------------------------
 
doc/guides/vdpadevs/mlx5.rst +3 -37
index 2c7a550afc..2717459b6f 100644
@@ -14,9 +14,7 @@ SR-IOV context.
 
 .. note::
 
-   Due to external dependencies, this driver is disabled in default
-   configuration of the "make" build. It can be enabled with
-   ``CONFIG_RTE_LIBRTE_MLX5_VDPA_PMD=y`` or by using "meson" build system which
+   This driver is enabled automatically when using "meson" build system which
    will detect dependencies.
 
 
@@ -65,42 +63,10 @@ Prerequisites
 Compilation options
 ~~~~~~~~~~~~~~~~~~~
 
-These options can be modified in the ``.config`` file.
-
-- ``CONFIG_RTE_LIBRTE_MLX5_VDPA_PMD`` (default **n**)
-
-  Toggle compilation of librte_pmd_mlx5 itself.
-
-- ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
-
-  Build PMD with additional code to make it loadable without hard
-  dependencies on **libibverbs** nor **libmlx5**, which may not be installed
-  on the target system.
-
-  In this mode, their presence is still required for it to run properly,
-  however their absence won't prevent a DPDK application from starting (with
-  ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
-  missing with ``ldd(1)``.
-
-  It works by moving these dependencies to a purpose-built rdma-core "glue"
-  plug-in which must either be installed in a directory whose name is based
-  on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a
-  standard location for the dynamic linker (e.g. ``/lib``) if left to the
-  default empty string (``""``).
-
-  This option has no performance impact.
-
-- ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
-
-  Embed static flavor of the dependencies **libibverbs** and **libmlx5**
-  in the PMD shared library or the executable static binary.
-
 .. note::
 
-   For BlueField, target should be set to ``arm64-bluefield-linux-gcc``. This
-   will enable ``CONFIG_RTE_LIBRTE_MLX5_VDPA_PMD`` and set
-   ``RTE_CACHE_LINE_SIZE`` to 64. Default armv8a configuration of make build and
-   meson build set it to 128 then brings performance degradation.
+   Default armv8a configuration of meson build sets ``RTE_CACHE_LINE_SIZE``
+   to 128 then brings performance degradation.
 
 Run-time configuration
 ~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.28.0
#194 lore raw

PATCH v4 24/31 doc: remove references to make from bbdevs guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/bbdevs/fpga_5gnr_fec.rst |  7 ++-----
 doc/guides/bbdevs/fpga_lte_fec.rst  |  7 ++-----
 doc/guides/bbdevs/turbo_sw.rst      | 15 ---------------
 3 files changed, 4 insertions(+), 25 deletions(-)
doc/guides/bbdevs/fpga_5gnr_fec.rst +2 -5
index 6760391e8c..8e00c4ef22 100644
@@ -51,10 +51,7 @@ FPGA 5GNR FEC does not support the following:
 Installation
 ------------
 
-Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. The
-default set of bbdev compile flags may be found in config/common_base, where for example
-the flag to build the FPGA 5GNR FEC device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_5GNR_FEC``,
-is already set.
+Section 3 of the DPDK manual provides instructions on installing and compiling DPDK.
 
 DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual.
 The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The
@@ -94,7 +91,7 @@ the UIO driver by repeating this command for every function.
 .. code-block:: console
 
   cd <dpdk-top-level-directory>
-  insmod ./build/kmod/igb_uio.ko
+  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
   echo "8086 0d8f" > /sys/bus/pci/drivers/igb_uio/new_id
   lspci -vd8086:0d8f
 
doc/guides/bbdevs/fpga_lte_fec.rst +2 -5
index fdc8a76981..14ffa0ee14 100644
@@ -50,10 +50,7 @@ FPGA LTE FEC does not support the following:
 Installation
 --------------
 
-Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. The
-default set of bbdev compile flags may be found in config/common_base, where for example
-the flag to build the FPGA LTE FEC device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_LTE_FEC``, is already
-set.
+Section 3 of the DPDK manual provides instructions on installing and compiling DPDK.
 
 DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual.
 The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The
@@ -93,7 +90,7 @@ the UIO driver by repeating this command for every function.
 .. code-block:: console
 
   cd <dpdk-top-level-directory>
-  insmod ./build/kmod/igb_uio.ko
+  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
   echo "1172 5052" > /sys/bus/pci/drivers/igb_uio/new_id
   lspci -vd1172:
 
doc/guides/bbdevs/turbo_sw.rst +0 -15
index 20620c2e20..3b93157890 100644
@@ -12,14 +12,6 @@ Note that the driver can also be built without any dependency with reduced
 functionality for maintenance purpose.
 
 To enable linking to the SDK libraries see detailed installation section below.
-Two flags can be enabled depending on whether the target machine can support
-AVX2 and AVX512 instructions sets and the related SDK libraries for vectorized
-signal processing functions are installed :
-- CONFIG_RTE_BBDEV_SDK_AVX2
-- CONFIG_RTE_BBDEV_SDK_AVX512
-By default these 2 flags are disabled by default. For AVX2 machine and SDK
-library installed then the first flag can be enabled. For AVX512 machine and
-SDK library installed then both flags can be enabled for full real time capability.
 
 This PMD supports the functions: FEC, Rate Matching and CRC functions detailed
 in the Features section.
@@ -151,13 +143,6 @@ Example:
     export FLEXRAN_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/install
     export DIR_WIRELESS_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/
 
-* Set ``CONFIG_RTE_BBDEV_SDK_AVX2=y`` and ``CONFIG_RTE_BBDEV_SDK_AVX512=y``
-  in DPDK common configuration file ``config/common_base`` to be able to use
-  the SDK libraries as mentioned above.
-  For AVX2 machine it is possible to only enable CONFIG_RTE_BBDEV_SDK_AVX2
-  for limited 4G functionality.
-  If no flag are set the PMD driver will still build but its capabilities
-  will be limited accordingly.
 
 To use the PMD in an application, user must:
 
Signature · 1 line
2.28.0
#195 lore raw

PATCH v4 25/31 doc: remove references to make from cryptodevs guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/cryptodevs/aesni_gcm.rst |  4 +-
 doc/guides/cryptodevs/aesni_mb.rst  |  4 +-
 doc/guides/cryptodevs/armv8.rst     |  3 --
 doc/guides/cryptodevs/caam_jr.rst   | 30 -------------
 doc/guides/cryptodevs/ccp.rst       | 14 +++---
 doc/guides/cryptodevs/dpaa2_sec.rst | 25 -----------
 doc/guides/cryptodevs/dpaa_sec.rst  | 25 -----------
 doc/guides/cryptodevs/kasumi.rst    | 11 +----
 doc/guides/cryptodevs/mvsam.rst     | 10 +----
 doc/guides/cryptodevs/nitrox.rst    |  7 ---
 doc/guides/cryptodevs/null.rst      |  2 +-
 doc/guides/cryptodevs/octeontx.rst  | 12 +-----
 doc/guides/cryptodevs/octeontx2.rst |  8 +---
 doc/guides/cryptodevs/openssl.rst   |  6 +--
 doc/guides/cryptodevs/qat.rst       | 67 +++++++----------------------
 doc/guides/cryptodevs/scheduler.rst |  8 ----
 doc/guides/cryptodevs/snow3g.rst    | 10 +----
 doc/guides/cryptodevs/virtio.rst    | 18 ++------
 doc/guides/cryptodevs/zuc.rst       | 10 +----
 19 files changed, 39 insertions(+), 235 deletions(-)
doc/guides/cryptodevs/aesni_gcm.rst +1 -3
index 74e0de63ad..013615e2d0 100644
@@ -96,8 +96,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Set CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=y in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_aesni_gcm") within the application.
@@ -117,5 +115,5 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"
doc/guides/cryptodevs/aesni_mb.rst +1 -3
index 15388d20ab..fd533ca65b 100644
@@ -131,8 +131,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Set CONFIG_RTE_LIBRTE_PMD_AESNI_MB=y in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_aesni_mb") within the application.
@@ -152,7 +150,7 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac"
 
 Extra notes
doc/guides/cryptodevs/armv8.rst +0 -3
index fee85354ba..d30ef6168e 100644
@@ -40,9 +40,6 @@ In order to enable this virtual crypto PMD, user must:
 
 	make -C $ARMV8_CRYPTO_LIB_PATH/
 
-* Set CONFIG_RTE_LIBRTE_PMD_ARMV8_CRYPTO=y in
-  config/defconfig_arm64-armv8a-linux-gcc
-
 The corresponding device can be created only if the following features
 are supported by the CPU:
 
doc/guides/cryptodevs/caam_jr.rst +0 -30
index 6d9daf7364..5ef33ae78e 100644
@@ -109,36 +109,6 @@ Currently supported by DPDK:
 
 * Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file
-to enable caam_jr PMD.
-
-Please note that enabling debugging options may affect system performance.
-
-* ``CONFIG_RTE_LIBRTE_PMD_CAAM_JR`` (default ``n``)
-  By default it is only enabled in common_linux config.
-  Toggle compilation of the ``librte_pmd_caam_jr`` driver.
-
-* ``CONFIG_RTE_LIBRTE_PMD_CAAM_JR_BE`` (default ``n``)
-  By default it is disabled.
-  It can be used when the underlying hardware supports the CAAM in BE mode.
-  LS1043A, LS1046A and LS1012A support CAAM in BE mode.
-  LS1028A supports CAAM in LE mode.
-
-Installations
--------------
-To compile the caam_jr PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-armv8a-linux-gcc install
 
 Enabling logs
 -------------
doc/guides/cryptodevs/ccp.rst +5 -9
index a43fe92de9..9ca1979994 100644
@@ -56,10 +56,8 @@ AEAD algorithms:
 Installation
 ------------
 
-To compile ccp PMD, it has to be enabled in the config/common_base file and openssl
-packages have to be installed in the build environment.
-
-* ``CONFIG_RTE_LIBRTE_PMD_CCP=y``
+To compile ccp PMD, openssl packages have to be installed in the build
+environment.
 
 For Ubuntu 16.04 LTS use below to install openssl in the build system:
 
@@ -77,7 +75,7 @@ e.g. for the 0x1456 device::
 
 	cd to the top-level DPDK directory
 	modprobe uio
-	insmod ./build/kmod/igb_uio.ko
+	insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
 	echo "1022 1456" > /sys/bus/pci/drivers/igb_uio/new_id
 
 Another way to bind the CCP devices to DPDK UIO driver is by using the ``dpdk-devbind.py`` script.
@@ -86,8 +84,6 @@ The following command assumes ``BFD`` as ``0000:09:00.2``::
 	cd to the top-level DPDK directory
 	./usertools/dpdk-devbind.py -b igb_uio 0000:09:00.2
 
-In order to enable the ccp crypto PMD, user must set CONFIG_RTE_LIBRTE_PMD_CCP=y in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_ccp") within the application.
@@ -109,7 +105,7 @@ To validate ccp pmd, l2fwd-crypto example can be used with following command:
 
 .. code-block:: console
 
-        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
+        sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
         --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc
         --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
         --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
@@ -124,7 +120,7 @@ following:
 
 .. code-block:: console
 
-        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1
+        sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1
         --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc
         --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
         --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
doc/guides/cryptodevs/dpaa2_sec.rst +0 -25
index 3053636b82..080768a2e7 100644
@@ -167,31 +167,6 @@ Currently supported by DPDK:
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-Basic DPAA2 config file options are described in :ref:`dpaa2_overview`.
-In addition to those, the following options can be modified in the ``config`` file
-to enable DPAA2_SEC PMD.
-
-Please note that enabling debugging options may affect system performance.
-
-* ``CONFIG_RTE_LIBRTE_PMD_DPAA2_SEC`` (default ``n``)
-  By default it is only enabled in defconfig_arm64-dpaa-* config.
-  Toggle compilation of the ``librte_pmd_dpaa2_sec`` driver.
-
-Installations
--------------
-To compile the DPAA2_SEC PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Enabling logs
 -------------
doc/guides/cryptodevs/dpaa_sec.rst +0 -25
index db3c8e9189..da14a68d9c 100644
@@ -111,31 +111,6 @@ See :doc:`../platform/dpaa` for setup information
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-Basic DPAA config file options are described in :ref:`dpaa_overview`.
-In addition to those, the following options can be modified in the ``config`` file
-to enable DPAA_SEC PMD.
-
-Please note that enabling debugging options may affect system performance.
-
-* ``CONFIG_RTE_LIBRTE_PMD_DPAA_SEC`` (default ``n``)
-  By default it is only enabled in defconfig_arm64-dpaa-* config.
-  Toggle compilation of the ``librte_pmd_dpaa_sec`` driver.
-
-Installations
--------------
-To compile the DPAA_SEC PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Enabling logs
 -------------
doc/guides/cryptodevs/kasumi.rst +1 -10
index 09a538f816..5770a60cb2 100644
@@ -89,15 +89,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Build DPDK as follows:
-
-.. code-block:: console
-
-	make config T=x86_64-native-linux-gcc
-	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_KASUMI\)=n,\1=y,' build/.config
-	make
-
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_kasumi") within the application.
@@ -117,7 +108,7 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "kasumi-f8"
 
 Extra notes on KASUMI F9
doc/guides/cryptodevs/mvsam.rst +1 -9
index 399fe37a67..6188c1248c 100644
@@ -64,14 +64,6 @@ Limitations
 Installation
 ------------
 
-MVSAM CRYPTO PMD driver compilation is disabled by default due to external dependencies.
-Currently there are two driver specific compilation options in
-``config/common_base`` available:
-
-- ``CONFIG_RTE_LIBRTE_PMD_MVSAM_CRYPTO`` (default: ``n``)
-
-    Toggle compilation of the librte_pmd_mvsam driver.
-
 MVSAM CRYPTO PMD requires MUSDK built with EIP197 support thus following
 extra option must be passed to the library configuration script:
 
@@ -105,7 +97,7 @@ operation:
 
 .. code-block:: console
 
-   ./l2fwd-crypto --vdev=eth_mvpp2,iface=eth0 --vdev=crypto_mvsam -- \
+   ./dpdk-l2fwd-crypto --vdev=eth_mvpp2,iface=eth0 --vdev=crypto_mvsam -- \
      --cipher_op ENCRYPT --cipher_algo aes-cbc \
      --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f  \
      --auth_op GENERATE --auth_algo sha1-hmac \
doc/guides/cryptodevs/nitrox.rst +0 -7
index 85f5212b64..2f0565b49e 100644
@@ -33,13 +33,6 @@ Limitations
 * 3DES Cipher Only combination is not supported.
 * Session-less APIs are not supported.
 
-Installation
-------------
-
-For compiling the Nitrox crypto PMD, please check if the
-CONFIG_RTE_LIBRTE_PMD_NITROX setting is set to `y` in config/common_base file.
-
-* ``CONFIG_RTE_LIBRTE_PMD_NITROX=y``
 
 Initialization
 --------------
doc/guides/cryptodevs/null.rst +1 -1
index c980e0ac84..aac5904b1d 100644
@@ -67,5 +67,5 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
doc/guides/cryptodevs/octeontx.rst +2 -10
index 4fa199e3c4..d813cb2974 100644
@@ -59,14 +59,6 @@ Supported Asymmetric Crypto Algorithms
 * ``RTE_CRYPTO_ASYM_XFORM_RSA``
 * ``RTE_CRYPTO_ASYM_XFORM_MODEX``
 
-Config flags
-------------
-
-For compiling the OCTEON TX crypto poll mode driver, please check if the
-CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO setting is set to `y` in
-config/common_base file.
-
-* ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO=y``
 
 Compilation
 -----------
@@ -135,7 +127,7 @@ application:
 
 .. code-block:: console
 
-        ./test
+        ./dpdk-test
         RTE>>cryptodev_octeontx_autotest
 
 The asymmetric crypto operations on OCTEON TX crypto PMD may be verified by running the test
@@ -143,5 +135,5 @@ application:
 
 .. code-block:: console
 
-        ./test
+        ./dpdk-test
         RTE>>cryptodev_octeontx_asym_autotest
doc/guides/cryptodevs/octeontx2.rst +2 -6
index 432146db04..bb4af3a04d 100644
@@ -70,10 +70,6 @@ Installation
 The OCTEON TX2 crypto PMD may be compiled natively on an OCTEON TX2 platform or
 cross-compiled on an x86 platform.
 
-Enable OCTEON TX2 crypto PMD in your config file:
-
-* ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_CRYPTO=y``
-
 Refer to :doc:`../platform/octeontx2` for instructions to build your DPDK
 application.
 
@@ -148,7 +144,7 @@ application:
 
 .. code-block:: console
 
-    ./test
+    ./dpdk-test
     RTE>>cryptodev_octeontx2_autotest
 
 The asymmetric crypto operations on OCTEON TX2 crypto PMD may be verified by running the test
@@ -156,7 +152,7 @@ application:
 
 .. code-block:: console
 
-    ./test
+    ./dpdk-test
     RTE>>cryptodev_octeontx2_asym_autotest
 
 
doc/guides/cryptodevs/openssl.rst +3 -3
index 7407294813..ca0f0b43f3 100644
@@ -58,8 +58,8 @@ Supported Asymmetric Crypto algorithms:
 Installation
 ------------
 
-To compile openssl PMD, it has to be enabled in the config/common_base file
-and appropriate openssl packages have to be installed in the build environment.
+To compile openssl PMD, appropriate openssl packages have to be installed
+in the build environment.
 
 The newest openssl library version is supported:
 
@@ -93,7 +93,7 @@ To verify real traffic l2fwd-crypto example can be used with this command:
 
 .. code-block:: console
 
-	sudo ./build/l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_openssl"
+	sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_openssl"
 	--vdev "crypto_openssl"-- -p 0x3 --chain CIPHER_HASH
 	--cipher_op ENCRYPT --cipher_algo AES_CBC
 	--cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
doc/guides/cryptodevs/qat.rst +16 -51

129 lines not on this page · raw message

doc/guides/cryptodevs/scheduler.rst +0 -8
index 7004ca431a..ee23b25b73 100644
@@ -32,14 +32,6 @@ Limitations
   is enabled.
 
 
-Installation
-------------
-
-To build DPDK with CRYTPO_SCHEDULER_PMD the user is required to set
-CONFIG_RTE_LIBRTE_PMD_CRYPTO_SCHEDULER=y in config/common_base, and
-recompile DPDK
-
-
 Initialization
 --------------
 
doc/guides/cryptodevs/snow3g.rst +1 -9
index e0cddc2d77..13341c39c4 100644
@@ -88,14 +88,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Build DPDK as follows:
-
-.. code-block:: console
-
-	make config T=x86_64-native-linux-gcc
-	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_SNOW3G\)=n,\1=y,' build/.config
-	make
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_snow3g") within the application.
@@ -115,5 +107,5 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "snow3g-uea2"
doc/guides/cryptodevs/virtio.rst +4 -14
index 2c46bda866..83d8e32397 100644
@@ -83,27 +83,17 @@ The unit test cases can be tested as below:
 .. code-block:: console
 
     reserve enough huge pages
-    cd to the top-level DPDK directory
-    export RTE_TARGET=x86_64-native-linux-gcc
-    export RTE_SDK=`pwd`
-    cd to app/test
-    type the command "make" to compile
-    run the tests with "./test"
-    type the command "cryptodev_virtio_autotest" to test
+    cd to <build_dir>
+    meson test cryptodev_virtio_autotest
 
 The performance can be tested as below:
 
 .. code-block:: console
 
     reserve enough huge pages
-    cd to the top-level DPDK directory
-    export RTE_TARGET=x86_64-native-linux-gcc
-    export RTE_SDK=`pwd`
-    cd to app/test-crypto-perf
-    type the command "make" to compile
-    run the tests with the following command:
+    cd to <build_dir>
 
-    ./dpdk-test-crypto-perf -l 0,1 -- --devtype crypto_virtio \
+    ./app/dpdk-test-crypto-perf -l 0,1 -- --devtype crypto_virtio \
         --ptest throughput --optype cipher-then-auth --cipher-algo aes-cbc \
         --cipher-op encrypt --cipher-key-sz 16 --auth-algo sha1-hmac \
         --auth-op generate --auth-key-sz 64 --digest-sz 12 \
doc/guides/cryptodevs/zuc.rst +1 -9
index 9b51ba141d..907840ef05 100644
@@ -88,14 +88,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Build DPDK as follows:
-
-.. code-block:: console
-
-	make config T=x86_64-native-linux-gcc
-	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_ZUC\)=n,\1=y,' build/.config
-	make
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_zuc") within the application.
@@ -115,5 +107,5 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3"
Signature · 1 line
2.28.0
#196 lore raw

PATCH v4 26/31 doc: remove references to make from compressdevs guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/compressdevs/isal.rst     |  4 ----
 doc/guides/compressdevs/octeontx.rst | 24 ++----------------------
 doc/guides/compressdevs/zlib.rst     |  4 ----
 3 files changed, 2 insertions(+), 30 deletions(-)
doc/guides/compressdevs/isal.rst +0 -4
index af1f41f240..1d146fb4a6 100644
@@ -133,10 +133,6 @@ Installation
 Initialization
 --------------
 
-In order to enable this virtual compression PMD, user must:
-
-* Set ``CONFIG_RTE_LIBRTE_PMD_ISAL=y`` in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call ``rte_vdev_init("compress_isal")`` within the application.
doc/guides/compressdevs/octeontx.rst +2 -22
index 5924ad1fa3..8c658721b9 100644
@@ -56,21 +56,6 @@ Steps To Setup Platform
 
    SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.
 
-Installation
-------------
-
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the OCTEON TX ZIP PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-   .. code-block:: console
-
-      cd <DPDK-source-directory>
-      make config T=arm64-thunderx-linux-gcc install
-
-
 Initialization
 --------------
 
@@ -96,10 +81,5 @@ probed. To use the PMD in an application, user must:
    .. code-block:: console
 
       reserve enough huge pages
-      cd to the top-level DPDK directory
-      export RTE_TARGET=arm64-thunderx-linux-gcc
-      export RTE_SDK=`pwd`
-      cd to app/test
-      type the command "make" to compile
-      run the tests with "./test"
-      type the command "compressdev_autotest" to test
+      cd to <build_dir>
+      meson test compressdev_autotest
doc/guides/compressdevs/zlib.rst +0 -4
index 986c59d43b..6e397ecd7e 100644
@@ -53,10 +53,6 @@ Installation
 Initialization
 --------------
 
-In order to enable this virtual compression PMD, user must:
-
-* Set ``CONFIG_RTE_LIBRTE_PMD_ZLIB=y`` in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call ``rte_vdev_init("compress_zlib")`` within the application.
Signature · 1 line
2.28.0
#197 lore raw

PATCH v4 27/31 doc: remove references to make from eventdevs guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/eventdevs/dpaa.rst      | 20 --------------------
 doc/guides/eventdevs/dpaa2.rst     | 20 --------------------
 doc/guides/eventdevs/octeontx.rst  | 24 ------------------------
 doc/guides/eventdevs/octeontx2.rst |  8 --------
 4 files changed, 72 deletions(-)
doc/guides/eventdevs/dpaa.rst +0 -20
index be68c6da6f..6fbee91d9e 100644
@@ -43,26 +43,6 @@ Currently supported by DPDK:
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_dpaa_event`` driver.
-
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA EVENTDEV PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/eventdevs/dpaa2.rst +0 -20
index 835767f98d..b992ae649e 100644
@@ -52,26 +52,6 @@ Currently supported by DPDK:
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_EVENTDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_dpaa2_event`` driver.
-
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA2 EVENTDEV PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/eventdevs/octeontx.rst +0 -24
index 9a3646db0d..f7a4cdd586 100644
@@ -41,30 +41,6 @@ Prerequisites
 
 See :doc:`../platform/octeontx` for setup information.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_SSOVF`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_octeontx_ssovf`` driver.
-
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the OCTEON TX SSOVF PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-thunderx-linux-gcc install
-
 
 Initialization
 --------------
doc/guides/eventdevs/octeontx2.rst +0 -8
index 6502f6415f..7f9eceb01f 100644
@@ -47,14 +47,6 @@ Prerequisites and Compilation procedure
 Pre-Installation Configuration
 ------------------------------
 
-Compile time Config Options
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following option can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_EVENTDEV`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_octeontx2_event`` driver.
 
 Runtime Config Options
 ~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.28.0
#198 lore raw

PATCH v4 28/31 doc: remove references to make from rawdevs guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/rawdevs/dpaa2_cmdif.rst   | 21 ---------------------
 doc/guides/rawdevs/dpaa2_qdma.rst    | 21 ---------------------
 doc/guides/rawdevs/ifpga.rst         | 10 ----------
 doc/guides/rawdevs/ioat.rst          |  8 +-------
 doc/guides/rawdevs/ntb.rst           |  6 ------
 doc/guides/rawdevs/octeontx2_dma.rst | 12 ------------
 doc/guides/rawdevs/octeontx2_ep.rst  |  8 --------
 7 files changed, 1 insertion(+), 85 deletions(-)
doc/guides/rawdevs/dpaa2_cmdif.rst +0 -21
index be9805874b..7ac3963938 100644
@@ -44,17 +44,6 @@ Currently supported by DPDK:
    Some part of fslmc bus code (mc flib - object library) routines are
    dual licensed (BSD & GPLv2).
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_CMDIF_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_dpaa2_cmdif`` driver.
 
 Enabling logs
 -------------
@@ -68,16 +57,6 @@ For enabling logs, use the following EAL parameter:
 Using ``pmd.raw.dpaa2.cmdif`` as log matching criteria, all Event PMD logs can be
 enabled which are lower than logging ``level``.
 
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA2 CMDIF PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/rawdevs/dpaa2_qdma.rst +0 -21
index 129e83d5ef..92921fafdd 100644
@@ -48,17 +48,6 @@ Currently supported by DPDK:
    Some part of fslmc bus code (mc flib - object library) routines are
    dual licensed (BSD & GPLv2).
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_QDMA_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_dpaa2_qdma`` driver.
 
 Enabling logs
 -------------
@@ -72,16 +61,6 @@ For enabling logs, use the following EAL parameter:
 Using ``pmd.raw.dpaa2.qdma`` as log matching criteria, all Event PMD logs can be
 enabled which are lower than logging ``level``.
 
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA2 QDMA PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/rawdevs/ifpga.rst +0 -10
index a3d92a62ea..dbd0d6e37d 100644
@@ -76,16 +76,6 @@ summarized by the following block diagram::
      |        vdev_ifpga_cfg driver       |        |  Intel FpgaDev  |
      +------------------------------------+        +-----------------+
 
-Build options
--------------
-
-- ``CONFIG_RTE_LIBRTE_IFPGA_BUS`` (default ``y``)
-
-   Toggle compilation of IFPGA Bus library.
-
-- ``CONFIG_RTE_LIBRTE_IFPGA_RAWDEV`` (default ``y``)
-
-   Toggle compilation of the ``ifpga_rawdev`` driver.
 
 Run-time parameters
 -------------------
doc/guides/rawdevs/ioat.rst +1 -7
index d0eee5e237..c0a08ff852 100644
@@ -54,13 +54,7 @@ shows:
 Compilation
 ------------
 
-For builds done with ``make``, the driver compilation is enabled by the
-``CONFIG_RTE_LIBRTE_PMD_IOAT_RAWDEV`` build configuration option. This is
-enabled by default in builds for x86 platforms, and disabled in other
-configurations.
-
-For builds using ``meson`` and ``ninja``, the driver will be built when the
-target platform is x86-based.
+The driver will be built when the target platform is x86-based.
 
 Device Setup
 -------------
doc/guides/rawdevs/ntb.rst +0 -6
index aa7d809649..0589b70087 100644
@@ -30,12 +30,6 @@ is https://www.intel.com/content/dam/support/us/en/documents/server-products/Int
 - Disable PCIe PII SSC (Spread Spectrum Clocking) for both hosts. This
   is a hardware requirement.
 
-Build Options
--------------
-
-- ``CONFIG_RTE_LIBRTE_PMD_NTB_RAWDEV`` (default ``y``)
-
-   Toggle compilation of the ``ntb`` driver.
 
 Device Setup
 ------------
doc/guides/rawdevs/octeontx2_dma.rst +0 -12
index 1e1dfbe931..f93ec1ffd7 100644
@@ -26,18 +26,6 @@ Prerequisites and Compilation procedure
    See :doc:`../platform/octeontx2` for setup information.
 
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_DMA_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_octeontx2_dma`` driver.
-
 Enabling logs
 -------------
 
doc/guides/rawdevs/octeontx2_ep.rst +0 -8
index bbcf530a45..4f91e78ab1 100644
@@ -18,14 +18,6 @@ This OCTEON TX2 End Point mode PMD supports
 
 #. Packet Output - OCTEON TX2 to Host with info pointer mode.
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_EP_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_octeontx2_ep`` driver.
 
 Initialization
 --------------
Signature · 1 line
2.28.0
#199 lore raw

PATCH v4 29/31 doc: remove references to make from app guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/sample_app_ug/bbdev_app.rst        | 34 ++-----
 doc/guides/sample_app_ug/cmd_line.rst         |  2 +-
 doc/guides/sample_app_ug/compiling.rst        | 89 +++++++------------
 doc/guides/sample_app_ug/dist_app.rst         |  4 +-
 doc/guides/sample_app_ug/ethtool.rst          |  2 +-
 .../sample_app_ug/eventdev_pipeline.rst       |  3 +-
 doc/guides/sample_app_ug/fips_validation.rst  | 10 +--
 doc/guides/sample_app_ug/flow_classify.rst    |  4 +-
 doc/guides/sample_app_ug/flow_filtering.rst   | 25 +-----
 doc/guides/sample_app_ug/hello_world.rst      |  2 +-
 doc/guides/sample_app_ug/ioat.rst             |  6 +-
 doc/guides/sample_app_ug/ip_frag.rst          |  6 +-
 doc/guides/sample_app_ug/ip_pipeline.rst      |  4 +-
 doc/guides/sample_app_ug/ip_reassembly.rst    |  9 +-
 doc/guides/sample_app_ug/ipsec_secgw.rst      | 14 +--
 doc/guides/sample_app_ug/ipv4_multicast.rst   |  4 +-
 doc/guides/sample_app_ug/keep_alive.rst       |  4 +-
 .../sample_app_ug/kernel_nic_interface.rst    | 14 +--
 doc/guides/sample_app_ug/l2_forward_cat.rst   |  4 +-
 .../sample_app_ug/l2_forward_crypto.rst       |  4 +-
 doc/guides/sample_app_ug/l2_forward_event.rst | 10 +--
 .../sample_app_ug/l2_forward_job_stats.rst    |  4 +-
 .../sample_app_ug/l2_forward_real_virtual.rst |  6 +-
 doc/guides/sample_app_ug/l3_forward.rst       | 10 +--
 .../sample_app_ug/l3_forward_access_ctrl.rst  |  6 +-
 doc/guides/sample_app_ug/l3_forward_graph.rst |  4 +-
 .../sample_app_ug/l3_forward_power_man.rst    | 14 ++-
 doc/guides/sample_app_ug/link_status_intr.rst |  4 +-
 doc/guides/sample_app_ug/multi_process.rst    | 20 ++---
 doc/guides/sample_app_ug/ntb.rst              |  2 +-
 doc/guides/sample_app_ug/packet_ordering.rst  |  3 +-
 .../sample_app_ug/performance_thread.rst      | 44 +++------
 doc/guides/sample_app_ug/ptpclient.rst        |  9 +-
 doc/guides/sample_app_ug/qos_metering.rst     |  2 +-
 doc/guides/sample_app_ug/qos_scheduler.rst    | 10 +--
 doc/guides/sample_app_ug/rxtx_callbacks.rst   |  9 +-
 doc/guides/sample_app_ug/server_node_efd.rst  |  2 +-
 doc/guides/sample_app_ug/service_cores.rst    | 23 +----
 doc/guides/sample_app_ug/skeleton.rst         |  2 +-
 doc/guides/sample_app_ug/tep_termination.rst  | 43 +++------
 doc/guides/sample_app_ug/test_pipeline.rst    |  4 +-
 doc/guides/sample_app_ug/timer.rst            |  2 +-
 doc/guides/sample_app_ug/vdpa.rst             |  4 +-
 doc/guides/sample_app_ug/vhost.rst            | 11 +--
 doc/guides/sample_app_ug/vhost_blk.rst        |  2 +-
 doc/guides/sample_app_ug/vhost_crypto.rst     |  2 +-
 .../sample_app_ug/vm_power_management.rst     | 34 +++----
 .../sample_app_ug/vmdq_dcb_forwarding.rst     |  8 +-
 doc/guides/sample_app_ug/vmdq_forwarding.rst  |  8 +-
 doc/guides/testpmd_app_ug/run_app.rst         |  6 +-
 doc/guides/testpmd_app_ug/testpmd_funcs.rst   |  9 +-
 51 files changed, 202 insertions(+), 359 deletions(-)
doc/guides/sample_app_ug/bbdev_app.rst +8 -26
index 405e706a46..764155f983 100644
@@ -31,30 +31,12 @@ Limitations
 Compiling the Application
 -------------------------
 
-#. DPDK needs to be built with ``baseband_turbo_sw`` PMD driver enabled along
-   with ``FLEXRAN SDK`` Libraries. Refer to *SW Turbo Poll Mode Driver*
-   documentation for more details on this.
+DPDK needs to be built with ``baseband_turbo_sw`` PMD driver enabled along
+with ``FLEXRAN SDK`` Libraries. Refer to *SW Turbo Poll Mode Driver*
+documentation for more details on this.
 
-#. Go to the example directory:
+To compile the sample application see :doc:`compiling`.
 
-    .. code-block:: console
-
-        export RTE_SDK=/path/to/rte_sdk
-        cd ${RTE_SDK}/examples/bbdev_app
-
-#. Set the target (a default target is used if not specified). For example:
-
-    .. code-block:: console
-
-        export RTE_TARGET=x86_64-native-linux-gcc
-
-    See the *DPDK Getting Started Guide* for possible RTE_TARGET values.
-
-#. Build the application:
-
-    .. code-block:: console
-
-        make
 
 Running the Application
 -----------------------
@@ -63,8 +45,8 @@ The application accepts a number of command line options:
 
 .. code-block:: console
 
-    $ ./build/bbdev [EAL options] -- [-e ENCODING_CORES] [-d DECODING_CORES] /
-    [-p ETH_PORT_ID] [-b BBDEV_ID]
+    $ ./<build_dir>/examples/dpdk-bbdev [EAL options] -- [-e ENCODING_CORES] /
+    [-d DECODING_CORES] [-p ETH_PORT_ID] [-b BBDEV_ID]
 
 where:
 
@@ -84,8 +66,8 @@ issue the command:
 
 .. code-block:: console
 
-    $ ./build/bbdev --vdev='baseband_turbo_sw' -w <NIC0PCIADDR> -c 0x38 --socket-mem=2,2 \
-    --file-prefix=bbdev -- -e 0x10 -d 0x20
+    $ ./<build_dir>/examples/dpdk-bbdev --vdev='baseband_turbo_sw' -w <NIC0PCIADDR> \
+    -c 0x38 --socket-mem=2,2 --file-prefix=bbdev -- -e 0x10 -d 0x20
 
 where, NIC0PCIADDR is the PCI address of the Rx port
 
doc/guides/sample_app_ug/cmd_line.rst +1 -1
index 6deb6c8112..5e3a25a317 100644
@@ -52,7 +52,7 @@ To run the application in linux environment, issue the following command:
 
 .. code-block:: console
 
-    $ ./build/cmdline -l 0-3 -n 4
+    $ ./<build_dir>/examples/dpdk-cmdline -l 0-3 -n 4
 
 Refer to the *DPDK Getting Started Guide* for general information on running applications
 and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/compiling.rst +32 -57

132 lines not on this page · raw message

doc/guides/sample_app_ug/dist_app.rst +2 -2
index 90270e3a58..3bd03905c3 100644
@@ -42,7 +42,7 @@ Running the Application
 
    ..  code-block:: console
 
-       ./build/distributor_app [EAL options] -- -p PORTMASK
+       ./<build-dir>/examples/dpdk-distributor [EAL options] -- -p PORTMASK
 
    where,
 
@@ -53,7 +53,7 @@ Running the Application
 
    ..  code-block:: console
 
-       $ ./build/distributor_app -l 1-9,22 -n 4 -- -p f
+       $ ./<build-dir>/examples/dpdk-distributor -l 1-9,22 -n 4 -- -p f
 
 #. Refer to the DPDK Getting Started Guide for general information on running
    applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/ethtool.rst +1 -1
index 253004dd00..7819871917 100644
@@ -24,7 +24,7 @@ The only available options are the standard ones for the EAL:
 
 .. code-block:: console
 
-    ./ethtool-app/${RTE_TARGET}/ethtool [EAL options]
+    ./<build_dir>/examples/dpdk-ethtool [EAL options]
 
 Refer to the *DPDK Getting Started Guide* for general information on
 running applications and the Environment Abstraction Layer (EAL)
doc/guides/sample_app_ug/eventdev_pipeline.rst +2 -1
index dc7972aa9a..b4fc587a09 100644
@@ -46,7 +46,8 @@ these settings is shown below:
 
 .. code-block:: console
 
-    ./build/eventdev_pipeline --vdev event_sw0 -- -r1 -t1 -e4 -w FF00 -s4 -n0 -c32 -W1000 -D
+    ./<build_dir>/examples/dpdk-eventdev_pipeline --vdev event_sw0 -- -r1 -t1 /
+    -e4 -w FF00 -s4 -n0 -c32 -W1000 -D
 
 The application has some sanity checking built-in, so if there is a function
 (e.g.; the RX core) which doesn't have a cpu core mask assigned, the application
doc/guides/sample_app_ug/fips_validation.rst +4 -6
index 2953fddeb9..8b009244b8 100644
@@ -70,9 +70,7 @@ Compiling the Application
 
 * Compile Application
 
-    .. code-block:: console
-
-         make -C examples/fips_validation
+    To compile the sample application see :doc:`compiling`.
 
 *  Run ``dos2unix`` on the request files
 
@@ -92,7 +90,7 @@ The application requires a number of command line options:
 
     .. code-block:: console
 
-         ./fips_validation [EAL options]
+         ./dpdk-fips_validation [EAL options]
          -- --req-file FILE_PATH/FOLDER_PATH
          --rsp-file FILE_PATH/FOLDER_PATH
          [--cryptodev DEVICE_NAME] [--cryptodev-id ID] [--path-is-folder]
@@ -117,7 +115,7 @@ file for crypto_aesni_mb PMD, issue the command:
 
 .. code-block:: console
 
-    $ ./fips_validation --vdev crypto_aesni_mb --
+    $ ./dpdk-fips_validation --vdev crypto_aesni_mb --
     --req-file /PATH/TO/REQUEST/FILE.req --rsp-file ./PATH/TO/RESPONSE/FILE.rsp
     --cryptodev crypto_aesni_mb
 
@@ -126,7 +124,7 @@ data files in one folder for crypto_aesni_gcm PMD, issue the command:
 
 .. code-block:: console
 
-    $ ./fips_validation --vdev crypto_aesni_gcm0 --
+    $ ./dpdk-fips_validation --vdev crypto_aesni_gcm0 --
     --req-file /PATH/TO/REQUEST/FILE/FOLDER/
     --rsp-file ./PATH/TO/RESPONSE/FILE/FOLDER/
     --cryptodev-id 0 --path-is-folder
doc/guides/sample_app_ug/flow_classify.rst +2 -2
index dc40b4d6f9..2ae22739c0 100644
@@ -28,8 +28,8 @@ To run the example in a ``linux`` environment:
 
 .. code-block:: console
 
-    cd ~/dpdk/examples/flow_classify
-    ./build/flow_classify -c 4 -n 4 -- --rule_ipv4="../ipv4_rules_file.txt"
+    ./<build_dir>/examples/dpdk-flow_classify -c 4 -n 4 -- /
+    --rule_ipv4="../ipv4_rules_file.txt"
 
 Please refer to the *DPDK Getting Started Guide*, section
 :doc:`../linux_gsg/build_sample_apps`
doc/guides/sample_app_ug/flow_filtering.rst +2 -23
index 5e5a6cd8a0..4a4006dc8e 100644
@@ -13,28 +13,7 @@ It is intended as a demonstration of the basic components RTE flow rules.
 Compiling the Application
 -------------------------
 
-To compile the application export the path to the DPDK source tree and go to
-the example directory:
-
-.. code-block:: console
-
-    export RTE_SDK=/path/to/rte_sdk
-
-    cd ${RTE_SDK}/examples/flow_filtering
-
-Set the target, for example:
-
-.. code-block:: console
-
-    export RTE_TARGET=x86_64-native-linux-gcc
-
-See the *DPDK Getting Started* Guide for possible ``RTE_TARGET`` values.
-
-Build the application as follows:
-
-.. code-block:: console
-
-    make
+To compile the sample application see :doc:`compiling`.
 
 
 Running the Application
@@ -44,7 +23,7 @@ To run the example in a ``linux`` environment:
 
 .. code-block:: console
 
-    ./build/flow -l 1 -n 1
+    ./<build_dir>/examples/dpdk-flow_filtering -l 1 -n 1
 
 Refer to *DPDK Getting Started Guide* for general information on running
 applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/hello_world.rst +1 -1
index 46f997a7dc..8f48533873 100644
@@ -21,7 +21,7 @@ To run the example in a linux environment:
 
 .. code-block:: console
 
-    $ ./build/helloworld -l 0-3 -n 4
+    $ ./<build_dir>/examples/dpdk-helloworld -l 0-3 -n 4
 
 Refer to *DPDK Getting Started Guide* for general information on running applications
 and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/ioat.rst +3 -3
index bab7654b8d..f35bee9d86 100644
@@ -45,7 +45,7 @@ The application requires a number of command line options:
 
 .. code-block:: console
 
-    ./build/ioatfwd [EAL options] -- [-p MASK] [-q NQ] [-s RS] [-c <sw|hw>]
+    ./<build_dir>/examples/dpdk-ioat [EAL options] -- [-p MASK] [-q NQ] [-s RS] [-c <sw|hw>]
         [--[no-]mac-updating]
 
 where,
@@ -81,7 +81,7 @@ updating issue the command:
 
 .. code-block:: console
 
-    $ ./build/ioatfwd -l 0-2 -n 2 -- -p 0x1 --mac-updating -c sw
+    $ ./<build_dir>/examples/dpdk-ioat -l 0-2 -n 2 -- -p 0x1 --mac-updating -c sw
 
 To run the application in a Linux environment with 2 lcores (the master lcore,
 plus one forwarding core), 2 ports (ports 0 and 1), hardware copying and no MAC
@@ -89,7 +89,7 @@ updating issue the command:
 
 .. code-block:: console
 
-    $ ./build/ioatfwd -l 0-1 -n 1 -- -p 0x3 --no-mac-updating -c hw
+    $ ./<build_dir>/examples/dpdk-ioat -l 0-1 -n 1 -- -p 0x3 --no-mac-updating -c hw
 
 Refer to the *DPDK Getting Started Guide* for general information on
 running applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/ip_frag.rst +3 -3
index afeaff3639..92d5e4aeae 100644
@@ -53,7 +53,7 @@ Application usage:
 
 .. code-block:: console
 
-    ./build/ip_fragmentation [EAL options] -- -p PORTMASK [-q NQ]
+    ./<build_dir>/examples/dpdk-ip_fragmentation [EAL options] -- -p PORTMASK [-q NQ]
 
 where:
 
@@ -65,7 +65,7 @@ To run the example in linux environment with 2 lcores (2,4) over 2 ports(0,2) wi
 
 .. code-block:: console
 
-    ./build/ip_fragmentation -l 2,4 -n 3 -- -p 5
+    ./<build_dir>/examples/dpdk-ip_fragmentation -l 2,4 -n 3 -- -p 5
     EAL: coremask set to 14
     EAL: Detected lcore 0 on socket 0
     EAL: Detected lcore 1 on socket 1
@@ -94,7 +94,7 @@ To run the example in linux environment with 1 lcore (4) over 2 ports(0,2) with
 
 .. code-block:: console
 
-    ./build/ip_fragmentation -l 4 -n 3 -- -p 5 -q 2
+    ./<build_dir>/examples/dpdk-ip_fragmentation -l 4 -n 3 -- -p 5 -q 2
 
 To test the application, flows should be set up in the flow generator that match the values in the
 l3fwd_ipv4_route_array and/or l3fwd_ipv6_route_array table.
doc/guides/sample_app_ug/ip_pipeline.rst +2 -2
index 56014be174..1d8656c637 100644
@@ -34,7 +34,7 @@ Running the application
 
 The application startup command line is::
 
-   ip_pipeline [EAL_ARGS] -- [-s SCRIPT_FILE] [-h HOST] [-p PORT]
+   dpdk-ip_pipeline [EAL_ARGS] -- [-s SCRIPT_FILE] [-h HOST] [-p PORT]
 
 The application startup arguments are:
 
@@ -71,7 +71,7 @@ The following is an example command to run ip pipeline application configured fo
 
 .. code-block:: console
 
-    $ ./build/ip_pipeline -c 0x3 -- -s examples/route_ecmp.cli
+    $ ./<build_dir>/examples/dpdk-ip_pipeline -c 0x3 -- -s examples/route_ecmp.cli
 
 The application should start successfully and display as follows:
 
doc/guides/sample_app_ug/ip_reassembly.rst +5 -4
index f34b9d0055..e72c8492e9 100644
@@ -42,7 +42,7 @@ The application has a number of command line options:
 
 .. code-block:: console
 
-    ./build/ip_reassembly [EAL options] -- -p PORTMASK [-q NQ] [--maxflows=FLOWS>] [--flowttl=TTL[(s|ms)]]
+    ./<build_dir>/examples/dpdk-ip_reassembly [EAL options] -- -p PORTMASK [-q NQ] [--maxflows=FLOWS>] [--flowttl=TTL[(s|ms)]]
 
 where:
 
@@ -61,7 +61,7 @@ To run the example in linux environment with 2 lcores (2,4) over 2 ports(0,2) wi
 
 .. code-block:: console
 
-    ./build/ip_reassembly -l 2,4 -n 3 -- -p 5
+    ./<build_dir>/examples/dpdk-ip_reassembly -l 2,4 -n 3 -- -p 5
     EAL: coremask set to 14
     EAL: Detected lcore 0 on socket 0
     EAL: Detected lcore 1 on socket 1
@@ -92,7 +92,7 @@ To run the example in linux environment with 1 lcore (4) over 2 ports(0,2) with
 
 .. code-block:: console
 
-    ./build/ip_reassembly -l 4 -n 3 -- -p 5 -q 2
+    ./<build_dir>/examples/dpdk-ip_reassembly -l 4 -n 3 -- -p 5 -q 2
 
 To test the application, flows should be set up in the flow generator that match the values in the
 l3fwd_ipv4_route_array and/or l3fwd_ipv6_route_array table.
@@ -231,7 +231,8 @@ Debug logging and Statistics Collection
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The RTE_LIBRTE_IP_FRAG_TBL_STAT controls statistics collection for the IP Fragment Table.
-This macro is disabled by default.
+This macro is disabled by default, but it can be enabled by modifying the appropriate line
+in ``config/rte_config.h``.
 To make ip_reassembly print the statistics to the standard output,
 the user must send either an USR1, INT or TERM signal to the process.
 For all of these signals, the ip_reassembly process prints Fragment table statistics for each RX queue,
doc/guides/sample_app_ug/ipsec_secgw.rst +4 -10
index 434f484138..1f37dccf8b 100644
@@ -116,12 +116,6 @@ To compile the sample application see :doc:`compiling`.
 
 The application is located in the ``ipsec-secgw`` sub-directory.
 
-#. [Optional] Build the application for debugging:
-   This option adds some extra flags, disables compiler optimizations and
-   is verbose::
-
-       make DEBUG=1
-
 
 Running the Application
 -----------------------
@@ -129,7 +123,7 @@ Running the Application
 The application has a number of command line options::
 
 
-   ./build/ipsec-secgw [EAL options] --
+   ./<build_dir>/examples/dpdk-ipsec-secgw [EAL options] --
                         -p PORTMASK -P -u PORTMASK -j FRAMESIZE
                         -l -w REPLAY_WINOW_SIZE -e -a
                         -c SAD_CACHE_SIZE
@@ -245,7 +239,7 @@ The mapping of lcores to port/queues is similar to other l3fwd applications.
 
 For example, given the following command line to run application in poll mode::
 
-    ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048       \
+    ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048       \
            --vdev "crypto_null" -- -p 0xf -P -u 0x3             \
            --config="(0,0,20),(1,0,20),(2,0,21),(3,0,21)"       \
            -f /path/to/config_file --transfer-mode poll         \
@@ -297,7 +291,7 @@ where each option means:
 Similarly for example, given the following command line to run application in
 event app mode::
 
-    ./build/ipsec-secgw -c 0x3 -- -P -p 0x3 -u 0x1       \
+    ./<build_dir>/examples/dpdk-ipsec-secgw -c 0x3 -- -P -p 0x3 -u 0x1       \
            -f /path/to/config_file --transfer-mode event \
            --event-schedule-type parallel                \
 
@@ -336,7 +330,7 @@ For example, something like the following command line:
 
 .. code-block:: console
 
-    ./build/ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
+    ./<build_dir>/examples/dpdk-ipsec-secgw -l 20,21 -n 4 --socket-mem 0,2048 \
             -w 81:00.0 -w 81:00.1 -w 81:00.2 -w 81:00.3 \
             --vdev "crypto_aesni_mb" --vdev "crypto_null" \
 	    -- \
doc/guides/sample_app_ug/ipv4_multicast.rst +2 -2
index 8923a7f548..7c6e8b15cc 100644
@@ -50,7 +50,7 @@ The application has a number of command line options:
 
 .. code-block:: console
 
-    ./build/ipv4_multicast [EAL options] -- -p PORTMASK [-q NQ]
+    ./<build_dir>/examples/dpdk-ipv4_multicast [EAL options] -- -p PORTMASK [-q NQ]
 
 where,
 
@@ -67,7 +67,7 @@ Typically, to run the IPv4 Multicast sample application, issue the following com
 
 .. code-block:: console
 
-    ./build/ipv4_multicast -l 0-3 -n 3 -- -p 0x3 -q 1
+    ./<build_dir>/examples/dpdk-ipv4_multicast -l 0-3 -n 3 -- -p 0x3 -q 1
 
 In this command:
 
doc/guides/sample_app_ug/keep_alive.rst +2 -2
index 865ba69e5c..ef7936f80f 100644
@@ -49,7 +49,7 @@ The application has a number of command line options:
 
 .. code-block:: console
 
-    ./build/l2fwd-keepalive [EAL options] \
+    ./<build_dir>/examples/dpdk-l2fwd-keepalive [EAL options] \
             -- -p PORTMASK [-q NQ] [-K PERIOD] [-T PERIOD]
 
 where,
@@ -68,7 +68,7 @@ To run the application in linux environment with 4 lcores, 16 ports
 
 .. code-block:: console
 
-    ./build/l2fwd-keepalive -l 0-3 -n 4 -- -q 8 -p ffff -K 10
+    ./<build_dir>/examples/dpdk-l2fwd-keepalive -l 0-3 -n 4 -- -q 8 -p ffff -K 10
 
 Refer to the *DPDK Getting Started Guide* for general information on
 running applications and the Environment Abstraction Layer (EAL)
doc/guides/sample_app_ug/kernel_nic_interface.rst +7 -7
index aac4ebd8d4..ef441cc1e5 100644
@@ -96,7 +96,7 @@ The ``kni`` example application requires a number of command line options:
 
 .. code-block:: console
 
-    kni [EAL options] -- -p PORTMASK --config="(port,lcore_rx,lcore_tx[,lcore_kthread,...])[,(port,lcore_rx,lcore_tx[,lcore_kthread,...])]" [-P] [-m]
+    dpdk-kni [EAL options] -- -p PORTMASK --config="(port,lcore_rx,lcore_tx[,lcore_kthread,...])[,(port,lcore_rx,lcore_tx[,lcore_kthread,...])]" [-P] [-m]
 
 Where:
 
@@ -168,8 +168,8 @@ interface ``vEth1_0`` with the kernel thread bound to lcore 9.
 .. code-block:: console
 
     # rmmod rte_kni
-    # insmod kmod/rte_kni.ko kthread_mode=multiple
-    # ./build/kni -l 4-7 -n 4 -- -P -p 0x3 -m --config="(0,4,6,8),(1,5,7,9)"
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko kthread_mode=multiple
+    # ./<build-dir>/examples/dpdk-kni -l 4-7 -n 4 -- -P -p 0x3 -m --config="(0,4,6,8),(1,5,7,9)"
 
 The following example is identical, except an additional ``lcore_kthread``
 core is specified per physical port.  In this case, ``kni`` will create
@@ -186,8 +186,8 @@ The kernel thread for each interface will be bound as follows:
 .. code-block:: console
 
     # rmmod rte_kni
-    # insmod kmod/rte_kni.ko kthread_mode=multiple
-    # ./build/kni -l 4-7 -n 4 -- -P -p 0x3 -m --config="(0,4,6,8,10),(1,5,7,9,11)"
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko kthread_mode=multiple
+    # ./<build-dir>/examples/dpdk-kni -l 4-7 -n 4 -- -P -p 0x3 -m --config="(0,4,6,8,10),(1,5,7,9,11)"
 
 The following example can be used to test the interface between the ``kni``
 test application and the ``rte_kni`` kernel module.  In this example,
@@ -206,8 +206,8 @@ disabled by **not** specifying the ``-m`` flag to ``kni``:
 .. code-block:: console
 
     # rmmod rte_kni
-    # insmod kmod/rte_kni.ko lo_mode=lo_mode_fifo carrier=on
-    # ./build/kni -l 4-7 -n 4 -- -P -p 0x3 --config="(0,4,6,8),(1,5,7,9)"
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo carrier=on
+    # ./<build-dir>/examples/dpdk-kni -l 4-7 -n 4 -- -P -p 0x3 --config="(0,4,6,8),(1,5,7,9)"
 
 KNI Operations
 --------------
doc/guides/sample_app_ug/l2_forward_cat.rst +2 -2
index 0a813200ba..c1be2d7dff 100644
@@ -70,13 +70,13 @@ To run the example in a ``linux`` environment and enable CAT on cpus 0-2:
 
 .. code-block:: console
 
-    ./build/l2fwd-cat -l 1 -n 4 -- --l3ca="0x3@(0-2)"
+    ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -n 4 -- --l3ca="0x3@(0-2)"
 
 or to enable CAT and CDP on cpus 1,3:
 
 .. code-block:: console
 
-    ./build/l2fwd-cat -l 1 -n 4 -- --l3ca="(0x00C00,0x00300)@(1,3)"
+    ./<build_dir>/examples/dpdk-l2fwd-cat -l 1 -n 4 -- --l3ca="(0x00C00,0x00300)@(1,3)"
 
 If CDP is not supported it will fail with following error message:
 
doc/guides/sample_app_ug/l2_forward_crypto.rst +2 -2
index 962752f21c..e2c0f9f1ec 100644
@@ -39,7 +39,7 @@ The application requires a number of command line options:
 
 .. code-block:: console
 
-    ./build/l2fwd-crypto [EAL options] -- [-p PORTMASK] [-q NQ] [-s] [-T PERIOD] /
+    ./<build_dir>/examples/dpdk-l2fwd-crypto [EAL options] -- [-p PORTMASK] [-q NQ] [-s] [-T PERIOD] /
     [--cdev_type HW/SW/ANY] [--chain HASH_CIPHER/CIPHER_HASH/CIPHER_ONLY/HASH_ONLY/AEAD] /
     [--cipher_algo ALGO] [--cipher_op ENCRYPT/DECRYPT] [--cipher_key KEY] /
     [--cipher_key_random_size SIZE] [--cipher_iv IV] [--cipher_iv_random_size SIZE] /
@@ -162,7 +162,7 @@ To run the application in linux environment with 2 lcores, 2 ports and 2 crypto
 
 .. code-block:: console
 
-    $ ./build/l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_aesni_mb0" \
+    $ ./<build_dir>/examples/dpdk-l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_aesni_mb0" \
     --vdev "crypto_aesni_mb1" -- -p 0x3 --chain CIPHER_HASH \
     --cipher_op ENCRYPT --cipher_algo aes-cbc \
     --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f \
doc/guides/sample_app_ug/l2_forward_event.rst +5 -5
index d536eee819..11c9d4b2ee 100644
@@ -52,7 +52,7 @@ The application requires a number of command line options:
 
 .. code-block:: console
 
-    ./build/l2fwd-event [EAL options] -- -p PORTMASK [-q NQ] --[no-]mac-updating --mode=MODE --eventq-sched=SCHED_MODE
+    ./<build_dir>/examples/dpdk-l2fwd-event [EAL options] -- -p PORTMASK [-q NQ] --[no-]mac-updating --mode=MODE --eventq-sched=SCHED_MODE
 
 where,
 
@@ -75,20 +75,20 @@ issue the command:
 
 .. code-block:: console
 
-    ./build/l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=poll
+    ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=poll
 
 Eventdev mode with 4 lcores, 16 ports , sched method ordered and MAC address updating enabled,
 issue the command:
 
 .. code-block:: console
 
-    ./build/l2fwd-event -l 0-3 -n 4 -- -p ffff --eventq-sched=ordered
+    ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -p ffff --eventq-sched=ordered
 
 or
 
 .. code-block:: console
 
-    ./build/l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered
+    ./<build_dir>/examples/dpdk-l2fwd-event -l 0-3 -n 4 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered
 
 Refer to the *DPDK Getting Started Guide* for general information on running
 applications and the Environment Abstraction Layer (EAL) options.
@@ -105,7 +105,7 @@ scheduler. Following is the sample command:
 
 .. code-block:: console
 
-    ./build/l2fwd-event -l 0-7 -s 0-3 -n 4 --vdev event_sw0 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered
+    ./<build_dir>/examples/dpdk-l2fwd-event -l 0-7 -s 0-3 -n 4 --vdev event_sw0 -- -q 8 -p ffff --mode=eventdev --eventq-sched=ordered
 
 Explanation
 -----------
doc/guides/sample_app_ug/l2_forward_job_stats.rst +2 -2
index 8d0c38721f..1a854abb23 100644
@@ -81,7 +81,7 @@ The application requires a number of command line options:
 
 .. code-block:: console
 
-    ./build/l2fwd-jobstats [EAL options] -- -p PORTMASK [-q NQ] [-l]
+    ./<build_dir>/examples/dpdk-l2fwd-jobstats [EAL options] -- -p PORTMASK [-q NQ] [-l]
 
 where,
 
@@ -96,7 +96,7 @@ thousands  separator printing, issue the command:
 
 .. code-block:: console
 
-    $ ./build/l2fwd-jobstats -l 0-3 -n 4 -- -q 8 -p ffff -l
+    $ ./<build_dir>/examples/dpdk-l2fwd-jobstats -l 0-3 -n 4 -- -q 8 -p ffff -l
 
 Refer to the *DPDK Getting Started Guide* for general information on running applications
 and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/l2_forward_real_virtual.rst +3 -3
index c0e8488e79..5a13de215e 100644
@@ -91,7 +91,7 @@ The application requires a number of command line options:
 
 .. code-block:: console
 
-    ./build/l2fwd [EAL options] -- -p PORTMASK
+    ./<build_dir>/examples/dpdk-l2fwd [EAL options] -- -p PORTMASK
                                    [-q NQ]
                                    --[no-]mac-updating
                                    [--portmap="(port, port)[,(port, port)]"]
@@ -111,7 +111,7 @@ updating enabled, issue the command:
 
 .. code-block:: console
 
-    $ ./build/l2fwd -l 0-3 -n 4 -- -q 8 -p ffff
+    $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p ffff
 
 To run the application in linux environment with 4 lcores, 4 ports, 8 RX queues
 per lcore, to forward RX traffic of ports 0 & 1 on ports 2 & 3 respectively and
@@ -119,7 +119,7 @@ vice versa, issue the command:
 
 .. code-block:: console
 
-    $ ./build/l2fwd -l 0-3 -n 4 -- -q 8 -p f --portmap="(0,2)(1,3)"
+    $ ./<build_dir>/examples/dpdk-l2fwd -l 0-3 -n 4 -- -q 8 -p f --portmap="(0,2)(1,3)"
 
 Refer to the *DPDK Getting Started Guide* for general information on running applications
 and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/l3_forward.rst +5 -5
index 07c8d44936..7acbd7404e 100644
@@ -51,7 +51,7 @@ Running the Application
 
 The application has a number of command line options::
 
-    ./l3fwd [EAL options] -- -p PORTMASK
+    ./dpdk-l3fwd [EAL options] -- -p PORTMASK
                              [-P]
                              [-E]
                              [-L]
@@ -111,7 +111,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s
 
 .. code-block:: console
 
-    ./build/l3fwd -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)"
+    ./<build_dir>/examples/dpdk-l3fwd -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)"
 
 In this command:
 
@@ -138,13 +138,13 @@ Following is the sample command:
 
 .. code-block:: console
 
-    ./build/l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x3 --eventq-sched=ordered
+    ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x3 --eventq-sched=ordered
 
 or
 
 .. code-block:: console
 
-    ./build/l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x03 --mode=eventdev --eventq-sched=ordered
+    ./<build_dir>/examples/dpdk-l3fwd -l 0-3 -n 4 -w <event device> -- -p 0x03 --mode=eventdev --eventq-sched=ordered
 
 In this command:
 
@@ -166,7 +166,7 @@ scheduler. Following is the sample command:
 
 .. code-block:: console
 
-    ./build/l3fwd -l 0-7 -s 0xf0000 -n 4 --vdev event_sw0 -- -p 0x3 --mode=eventdev --eventq-sched=ordered
+    ./<build_dir>/examples/dpdk-l3fwd -l 0-7 -s 0xf0000 -n 4 --vdev event_sw0 -- -p 0x3 --mode=eventdev --eventq-sched=ordered
 
 In case of eventdev mode, *--config* option is not used for ethernet port
 configuration. Instead each ethernet port will be configured with mentioned
doc/guides/sample_app_ug/l3_forward_access_ctrl.rst +3 -3
index a44fbcd52c..d3c901f8d8 100644
@@ -184,7 +184,7 @@ Packet 2 matches Rule 2 and is forwarded to port 1.
 Packet 3 matches Rule 3 and is forwarded to port 0.
 
 For more details on the rule file format,
-please refer to rule_ipv4.db and rule_ipv6.db files (inside <RTE_SDK>/examples/l3fwd-acl/).
+please refer to rule_ipv4.db and rule_ipv6.db files (inside dpdk/examples/l3fwd-acl/).
 
 Application Phases
 ~~~~~~~~~~~~~~~~~~
@@ -236,7 +236,7 @@ The application has a number of command line options:
 
 ..  code-block:: console
 
-    ./build/l3fwd-acl [EAL options] -- -p PORTMASK [-P] --config(port,queue,lcore)[,(port,queue,lcore)] --rule_ipv4 FILENAME rule_ipv6 FILENAME [--scalar] [--enable-jumbo [--max-pkt-len PKTLEN]] [--no-numa]
+    ./<build_dir>/examples/dpdk-l3fwd-acl [EAL options] -- -p PORTMASK [-P] --config(port,queue,lcore)[,(port,queue,lcore)] --rule_ipv4 FILENAME rule_ipv6 FILENAME [--scalar] [--enable-jumbo [--max-pkt-len PKTLEN]] [--no-numa]
 
 
 where,
@@ -268,7 +268,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s
 
 ..  code-block:: console
 
-    ./build/l3fwd-acl -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="./rule_ipv4.db" -- rule_ipv6="./rule_ipv6.db" --scalar
+    ./<build_dir>/examples/dpdk-l3fwd-acl -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)" --rule_ipv4="./rule_ipv4.db" -- rule_ipv6="./rule_ipv6.db" --scalar
 
 In this command:
 
doc/guides/sample_app_ug/l3_forward_graph.rst +2 -2
index df50827bab..75617e3af1 100644
@@ -44,7 +44,7 @@ Running the Application
 
 The application has a number of command line options similar to l3fwd::
 
-    ./l3fwd-graph [EAL options] -- -p PORTMASK
+    ./dpdk-l3fwd-graph [EAL options] -- -p PORTMASK
                                    [-P]
                                    --config(port,queue,lcore)[,(port,queue,lcore)]
                                    [--eth-dest=X,MM:MM:MM:MM:MM:MM]
@@ -79,7 +79,7 @@ To enable L3 forwarding between two ports, assuming that both ports are in the s
 
 .. code-block:: console
 
-    ./build/l3fwd-graph -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)"
+    ./<build_dir>/examples/dpdk-l3fwd-graph -l 1,2 -n 4 -- -p 0x3 --config="(0,0,1),(1,0,2)"
 
 In this command:
 
doc/guides/sample_app_ug/l3_forward_power_man.rst +5 -9
index 0cc6f2e62e..4f997108ba 100644
@@ -88,7 +88,7 @@ The application has a number of command line options:
 
 .. code-block:: console
 
-    ./build/l3fwd_power [EAL options] -- -p PORTMASK [-P]  --config(port,queue,lcore)[,(port,queue,lcore)] [--enable-jumbo [--max-pkt-len PKTLEN]] [--no-numa]
+    ./<build_dir>/examples/dpdk-l3fwd_power [EAL options] -- -p PORTMASK [-P]  --config(port,queue,lcore)[,(port,queue,lcore)] [--enable-jumbo [--max-pkt-len PKTLEN]] [--no-numa]
 
 where,
 
@@ -378,7 +378,7 @@ See :doc:`Power Management<../prog_guide/power_man>` chapter in the DPDK Program
 
 .. code-block:: console
 
-    ./l3fwd-power -l xxx   -n 4   -w 0000:xx:00.0 -w 0000:xx:00.1 -- -p 0x3 -P --config="(0,0,xx),(1,0,xx)" --empty-poll="0,0,0" -l 14 -m 9 -h 1
+    ./<build_dir>/examples/dpdk-l3fwd-power -l xxx   -n 4   -w 0000:xx:00.0 -w 0000:xx:00.1 -- -p 0x3 -P --config="(0,0,xx),(1,0,xx)" --empty-poll="0,0,0" -l 14 -m 9 -h 1
 
 Where,
 
@@ -407,7 +407,7 @@ app with the training flag set to “1”, and the other parameters set to
 
 .. code-block:: console
 
-        ./examples/l3fwd-power/build/l3fwd-power -l 1-3 -- -p 0x0f --config="(0,0,2),(0,1,3)" --empty-poll "1,0,0" –P
+        ./<build_dir>/examples/dpdk-l3fwd-power -l 1-3 -- -p 0x0f --config="(0,0,2),(0,1,3)" --empty-poll "1,0,0" –P
 
 This will run the training algorithm for x seconds on each core (cores 2
 and 3), and then print out the recommended threshold values for those
@@ -432,7 +432,7 @@ then be started without the training mode so traffic can start immediately.
 
 .. code-block:: console
 
-        ./examples/l3fwd-power/build/l3fwd-power -l 1-3 -- -p 0x0f --config="(0,0,2),(0,1,3)" --empty-poll "0,340000,540000" –P
+        ./<build_dir>/examples/dpdk-l3fwd-power -l 1-3 -- -p 0x0f --config="(0,0,2),(0,1,3)" --empty-poll "0,340000,540000" –P
 
 Telemetry Mode
 --------------
@@ -449,13 +449,9 @@ cycles it took is measured and compared with minimum and maximum
 reference cycles and accordingly busy rate is set  to either 0% or
 50% or 100%.
 
-   .. Note::
-
-      * The CONFIG_RTE_LIBRTE_TELEMETRY should be set in order to get the stats in DPDK telemetry.
-
 .. code-block:: console
 
-        ./examples/l3fwd-power/build/l3fwd-power --telemetry -l 1-3 -- -p 0x0f --config="(0,0,2),(0,1,3)" --telemetry
+        ./<build_dir>/examples/dpdk-l3fwd-power --telemetry -l 1-3 -- -p 0x0f --config="(0,0,2),(0,1,3)" --telemetry
 
 The new stats ``empty_poll`` , ``full_poll`` and ``busy_percent`` can be viewed by running the script
 ``/usertools/dpdk-telemetry-client.py`` and selecting the menu option ``Send for global Metrics``.
doc/guides/sample_app_ug/link_status_intr.rst +2 -2
index 04c40f2854..75bfd78505 100644
@@ -39,7 +39,7 @@ The application requires a number of command line options:
 
 .. code-block:: console
 
-    ./build/link_status_interrupt [EAL options] -- -p PORTMASK [-q NQ][-T PERIOD]
+    ./<build_dir>/examples/dpdk-link_status_interrupt [EAL options] -- -p PORTMASK [-q NQ][-T PERIOD]
 
 where,
 
@@ -54,7 +54,7 @@ issue the command:
 
 .. code-block:: console
 
-    $ ./build/link_status_interrupt -l 0-3 -n 4-- -q 8 -p ffff
+    $ ./<build_dir>/examples/dpdk-link_status_interrupt -l 0-3 -n 4-- -q 8 -p ffff
 
 Refer to the *DPDK Getting Started Guide* for general information on running applications
 and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/multi_process.rst +10 -10
index f2a79a6397..8b2858b971 100644
@@ -41,7 +41,7 @@ passing at least two cores in the coremask/corelist, as follows:
 
 .. code-block:: console
 
-    ./build/simple_mp -l 0-1 -n 4 --proc-type=primary
+    ./<build_dir>/examples/dpdk-simple_mp -l 0-1 -n 4 --proc-type=primary
 
 For the first DPDK process run, the proc-type flag can be omitted or set to auto,
 since all DPDK processes will default to being a primary instance,
@@ -50,7 +50,7 @@ The process should start successfully and display a command prompt as follows:
 
 .. code-block:: console
 
-    $ ./build/simple_mp -l 0-1 -n 4 --proc-type=primary
+    $ ./<build_dir>/examples/dpdk-simple_mp -l 0-1 -n 4 --proc-type=primary
     EAL: coremask set to 3
     EAL: Detected lcore 0 on socket 0
     EAL: Detected lcore 1 on socket 0
@@ -78,7 +78,7 @@ again run the same binary setting at least two cores in the coremask/corelist:
 
 .. code-block:: console
 
-    ./build/simple_mp -l 2-3 -n 4 --proc-type=secondary
+    ./<build_dir>/examples/dpdk-simple_mp -l 2-3 -n 4 --proc-type=secondary
 
 When running a secondary process such as that shown above, the proc-type parameter can again be specified as auto.
 However, omitting the parameter altogether will cause the process to try and start as a primary rather than secondary process.
@@ -184,10 +184,10 @@ the following commands can be used (assuming run as root):
 
 .. code-block:: console
 
-    # ./build/symmetric_mp -l 1 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=0
-    # ./build/symmetric_mp -l 2 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=1
-    # ./build/symmetric_mp -l 3 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=2
-    # ./build/symmetric_mp -l 4 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=3
+    # ./<build_dir>/examples/dpdk-symmetric_mp -l 1 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=0
+    # ./<build_dir>/examples/dpdk-symmetric_mp -l 2 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=1
+    # ./<build_dir>/examples/dpdk-symmetric_mp -l 3 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=2
+    # ./<build_dir>/examples/dpdk-symmetric_mp -l 4 -n 4 --proc-type=auto -- -p 3 --num-procs=4 --proc-id=3
 
 .. note::
 
@@ -284,9 +284,9 @@ the following commands could be used:
 
 .. code-block:: console
 
-    # ./mp_server/build/mp_server -l 1-2 -n 4 -- -p 3 -n 2
-    # ./mp_client/build/mp_client -l 3 -n 4 --proc-type=auto -- -n 0
-    # ./mp_client/build/mp_client -l 4 -n 4 --proc-type=auto -- -n 1
+    # ./<build_dir>/examples/dpdk-mp_server -l 1-2 -n 4 -- -p 3 -n 2
+    # ./<build_dir>/examples/dpdk-mp_client -l 3 -n 4 --proc-type=auto -- -n 0
+    # ./<build_dir>/examples/dpdk-mp_client -l 4 -n 4 --proc-type=auto -- -n 1
 
 .. note::
 
doc/guides/sample_app_ug/ntb.rst +1 -1
index 93fb752f25..f80b221db7 100644
@@ -32,7 +32,7 @@ The only available options are the standard ones for the EAL:
 
 .. code-block:: console
 
-    ./build/ntb_fwd -c 0xf -n 6 -- -i
+    ./<build_dir>/examples/dpdk-ntb -c 0xf -n 6 -- -i
 
 Refer to the *DPDK Getting Started Guide* for general information on
 running applications and the Environment Abstraction Layer (EAL)
doc/guides/sample_app_ug/packet_ordering.rst +2 -1
index 1c8ee5d040..5a4e0a9d28 100644
@@ -43,7 +43,8 @@ The application execution command line is:
 
 .. code-block:: console
 
-    ./packet_ordering [EAL options] -- -p PORTMASK [--disable-reorder] [--insight-worker]
+    ./<build_dir>/examples/dpdk-packet_ordering [EAL options] -- -p PORTMASK /
+    [--disable-reorder] [--insight-worker]
 
 The -c EAL CPU_COREMASK option has to contain at least 3 CPU cores.
 The first CPU core in the core mask is the master core and would be assigned to
doc/guides/sample_app_ug/performance_thread.rst +13 -31

121 lines not on this page · raw message

doc/guides/sample_app_ug/ptpclient.rst +1 -8
index 12b4f13d5b..a58b6f35bf 100644
@@ -57,13 +57,6 @@ To compile the sample application see :doc:`compiling`.
 
 The application is located in the ``ptpclient`` sub-directory.
 
-.. note::
-   To compile the application edit the ``config/common_linux`` configuration file to enable IEEE1588
-   and then recompile DPDK:
-
-   .. code-block:: console
-
-      CONFIG_RTE_LIBRTE_IEEE1588=y
 
 Running the Application
 -----------------------
@@ -72,7 +65,7 @@ To run the example in a ``linux`` environment:
 
 .. code-block:: console
 
-    ./build/ptpclient -l 1 -n 4 -- -p 0x1 -T 0
+    ./<build_dir>/examples/dpdk-ptpclient -l 1 -n 4 -- -p 0x1 -T 0
 
 Refer to *DPDK Getting Started Guide* for general information on running
 applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/qos_metering.rst +1 -1
index d75f7da52c..6b6853a0e9 100644
@@ -48,7 +48,7 @@ The application execution command line is as below:
 
 .. code-block:: console
 
-    ./qos_meter [EAL options] -- -p PORTMASK
+    ./dpdk-qos_meter [EAL options] -- -p PORTMASK
 
 The application is constrained to use a single core in the EAL core mask and 2 ports only in the application port mask
 (first port from the port mask is used for RX and the other port in the core mask is used for TX).
doc/guides/sample_app_ug/qos_scheduler.rst +5 -5
index b5010657a7..801f5e1286 100644
@@ -42,8 +42,8 @@ The application is located in the ``qos_sched`` sub-directory.
 .. note::
 
     To get statistics on the sample app using the command line interface as described in the next section,
-    DPDK must be compiled defining *CONFIG_RTE_SCHED_COLLECT_STATS*,
-    which can be done by changing the configuration file for the specific target to be compiled.
+    DPDK must be compiled defining *RTE_SCHED_COLLECT_STATS*, which can be done by changing the relevant
+    entry in the ``config/rte_config.h`` file.
 
 Running the Application
 -----------------------
@@ -57,7 +57,7 @@ The application has a number of command line options:
 
 .. code-block:: console
 
-    ./qos_sched [EAL options] -- <APP PARAMS>
+    ./<build_dir>/examples/dpdk-qos_sched [EAL options] -- <APP PARAMS>
 
 Mandatory application parameters include:
 
@@ -315,7 +315,7 @@ The following is an example command with a single packet flow configuration:
 
 .. code-block:: console
 
-    ./qos_sched -l 1,5,7 -n 4 -- --pfc "3,2,5,7" --cfg ./profile.cfg
+    ./<build_dir>/examples/dpdk-qos_sched -l 1,5,7 -n 4 -- --pfc "3,2,5,7" --cfg ./profile.cfg
 
 This example uses a single packet flow configuration which creates one RX thread on lcore 5 reading
 from port 3 and a worker thread on lcore 7 writing to port 2.
@@ -324,7 +324,7 @@ Another example with 2 packet flow configurations using different ports but shar
 
 .. code-block:: console
 
-   ./qos_sched -l 1,2,6,7 -n 4 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg
+   ./<build_dir>/examples/dpdk-qos_sched -l 1,2,6,7 -n 4 -- --pfc "3,2,2,6,7" --pfc "1,0,2,6,7" --cfg ./profile.cfg
 
 Note that independent cores for the packet flow configurations for each of the RX, WT and TX thread are also supported,
 providing flexibility to balance the work.
doc/guides/sample_app_ug/rxtx_callbacks.rst +1 -8
index 0a69ec71ab..62d1f39d7e 100644
@@ -25,13 +25,6 @@ To compile the sample application see :doc:`compiling`.
 
 The application is located in the ``rxtx_callbacks`` sub-directory.
 
-The callbacks feature requires that the ``CONFIG_RTE_ETHDEV_RXTX_CALLBACKS``
-setting is on in the ``config/common_`` config file that applies to the
-target. This is generally on by default:
-
-.. code-block:: console
-
-    CONFIG_RTE_ETHDEV_RXTX_CALLBACKS=y
 
 Running the Application
 -----------------------
@@ -40,7 +33,7 @@ To run the example in a ``linux`` environment:
 
 .. code-block:: console
 
-    ./build/rxtx_callbacks -l 1 -n 4 -- [-t]
+    ./<build_dir>/examples/dpdk-rxtx_callbacks -l 1 -n 4 -- [-t]
 
 Use -t to enable hardware timestamping. If not supported by the NIC, an error
 will be displayed.
doc/guides/sample_app_ug/server_node_efd.rst +1 -1
index 12208f4258..f27d1ccfce 100644
@@ -93,7 +93,7 @@ and the back-end node.
 
 The frontend server (server) has the following command line options::
 
-    ./server [EAL options] -- -p PORTMASK -n NUM_NODES -f NUM_FLOWS
+    ./<build_dir>/examples/dpdk-server [EAL options] -- -p PORTMASK -n NUM_NODES -f NUM_FLOWS
 
 Where,
 
doc/guides/sample_app_ug/service_cores.rst +3 -20
index cd0f4717aa..9202be6ea9 100644
@@ -20,26 +20,9 @@ is application specific, and not a part of the service cores API.
 Compiling the Application
 -------------------------
 
-#.  Go to the example directory:
+To compile the sample application see :doc:`compiling`.
 
-    .. code-block:: console
-
-        export RTE_SDK=/path/to/rte_sdk
-        cd ${RTE_SDK}/examples/service_cores
-
-#.  Set the target (a default target is used if not specified). For example:
-
-    .. code-block:: console
-
-        export RTE_TARGET=x86_64-native-linux-gcc
-
-    See the *DPDK Getting Started* Guide for possible RTE_TARGET values.
-
-#.  Build the application:
-
-    .. code-block:: console
-
-        make
+The application is located in the ``service_cores`` sub-directory.
 
 Running the Application
 -----------------------
@@ -50,7 +33,7 @@ pass a service core-mask as an EAL argument at startup time.
 
 .. code-block:: console
 
-    $ ./build/service_cores
+    $ ./<build_dir>/examples/dpdk-service_cores
 
 
 Explanation
doc/guides/sample_app_ug/skeleton.rst +1 -1
index 34f6f9aea7..263d8debc8 100644
@@ -25,7 +25,7 @@ To run the example in a ``linux`` environment:
 
 .. code-block:: console
 
-    ./build/basicfwd -l 1 -n 4
+    ./<build_dir>/examples/dpdk-skeleton -l 1 -n 4
 
 Refer to *DPDK Getting Started Guide* for general information on running
 applications and the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/tep_termination.rst +12 -31

97 lines not on this page · raw message

doc/guides/sample_app_ug/test_pipeline.rst +2 -2
index 5aefd8d89f..d57d08fb2c 100644
@@ -32,7 +32,7 @@ Compiling the Application
 -------------------------
 To compile the sample application see :doc:`compiling`
 
-The application is located in the ``$RTE_SDK/app/test-pipeline`` directory.
+The application is located in the ``dpdk/<build_dir>/app`` directory.
 
 
 Running the Application
@@ -45,7 +45,7 @@ The application execution command line is:
 
 .. code-block:: console
 
-    ./test-pipeline [EAL options] -- -p PORTMASK --TABLE_TYPE
+    ./dpdk-test-pipeline [EAL options] -- -p PORTMASK --TABLE_TYPE
 
 The -c or -l EAL CPU coremask/corelist option has to contain exactly 3 CPU cores.
 The first CPU core in the core mask is assigned for core A, the second for core B and the third for core C.
doc/guides/sample_app_ug/timer.rst +1 -1
index 98d762d238..94cee9819d 100644
@@ -21,7 +21,7 @@ To run the example in linux environment:
 
 .. code-block:: console
 
-    $ ./build/timer -l 0-3 -n 4
+    $ ./<build_dir>/examples/dpdk-timer -l 0-3 -n 4
 
 Refer to the *DPDK Getting Started Guide* for general information on running applications and
 the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/vdpa.rst +2 -2
index d66a724827..a8bedbab53 100644
@@ -29,7 +29,7 @@ Start the vdpa example
 
 .. code-block:: console
 
-        ./vdpa [EAL options]  -- [--client] [--interactive|-i] or [--iface SOCKET_PATH]
+        ./dpdk-vdpa [EAL options]  -- [--client] [--interactive|-i] or [--iface SOCKET_PATH]
 
 where
 
@@ -51,7 +51,7 @@ Take IFCVF driver for example:
 
 .. code-block:: console
 
-        ./vdpa -c 0x2 -n 4 --socket-mem 1024,1024 \
+        ./dpdk-vdpa -c 0x2 -n 4 --socket-mem 1024,1024 \
                 -w 0000:06:00.3,vdpa=1 -w 0000:06:00.4,vdpa=1 \
                 -- --interactive
 
doc/guides/sample_app_ug/vhost.rst +3 -8
index b7ed4f8bdf..bacf7898f9 100644
@@ -38,7 +38,7 @@ Start the vswitch example
 
 .. code-block:: console
 
-        ./vhost-switch -l 0-3 -n 4 --socket-mem 1024  \
+        ./dpdk-vhost-switch -l 0-3 -n 4 --socket-mem 1024  \
              -- --socket-file /tmp/sock0 --client \
              ...
 
@@ -78,13 +78,13 @@ could be done by:
 .. code-block:: console
 
    modprobe uio_pci_generic
-   $RTE_SDK/usertools/dpdk-devbind.py -b uio_pci_generic 0000:00:04.0
+   dpdk/usertools/dpdk-devbind.py -b uio_pci_generic 0000:00:04.0
 
 Then start testpmd for packet forwarding testing.
 
 .. code-block:: console
 
-    ./x86_64-native-gcc/app/testpmd -l 0-1 -- -i
+    ./<build_dir>/app/dpdk-testpmd -l 0-1 -- -i
     > start tx_first
 
 Inject packets
@@ -192,11 +192,6 @@ Common Issues
   max queue number is larger than 128, device start will fail due to
   insufficient mbuf.
 
-  Change the default number to make it work as below, just set the number
-  according to the NIC's property. ::
-
-      make EXTRA_CFLAGS="-DMAX_QUEUES=320"
-
 * Option "builtin-net-driver" is incompatible with QEMU
 
   QEMU vhost net device start will fail if protocol feature is not negotiated.
doc/guides/sample_app_ug/vhost_blk.rst +1 -1
index 681de6f3e1..788eef0d5f 100644
@@ -36,7 +36,7 @@ Start the vhost_blk example
 
 .. code-block:: console
 
-        ./vhost_blk -m 1024
+        ./dpdk-vhost_blk -m 1024
 
 .. _vhost_blk_app_run_vm:
 
doc/guides/sample_app_ug/vhost_crypto.rst +1 -1
index bbc25bde1c..7ae7addac4 100644
@@ -28,7 +28,7 @@ Start the vhost_crypto example
 
 .. code-block:: console
 
-    ./vhost_crypto [EAL options] --
+    ./dpdk-vhost_crypto [EAL options] --
     		--config (lcore,cdev-id,queue-id)[,(lcore,cdev-id,queue-id)]
     		--socket-file lcore,PATH
     		[--zero-copy]
doc/guides/sample_app_ug/vm_power_management.rst +14 -20
index 1b6de8e936..35afdac63f 100644
@@ -245,26 +245,23 @@ To build just the ``vm_power_manager`` application using ``make``:
 
 .. code-block:: console
 
-   export RTE_SDK=/path/to/rte_sdk
-   export RTE_TARGET=build
-   cd ${RTE_SDK}/examples/vm_power_manager/
+   cd dpdk/examples/vm_power_manager/
    make
 
-The resulting binary is ``${RTE_SDK}/build/examples/vm_power_manager``.
+The resulting binary is ``dpdk/build/examples/vm_power_manager``.
 
 To build just the ``vm_power_manager`` application using ``meson``/``ninja``:
 
 .. code-block:: console
 
-   export RTE_SDK=/path/to/rte_sdk
-   cd ${RTE_SDK}
+   cd dpdk
    meson build
    cd build
    ninja
    meson configure -Dexamples=vm_power_manager
    ninja
 
-The resulting binary is ``${RTE_SDK}/build/examples/dpdk-vm_power_manager``.
+The resulting binary is ``dpdk/build/examples/dpdk-vm_power_manager``.
 
 Running the Host Application
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -274,7 +271,7 @@ than the EAL options:
 
 .. code-block:: console
 
-   ./build/vm_power_mgr [EAL options]
+   ./<build_dir>/examples/dpdk-vm_power_mgr [EAL options]
 
 The application requires exactly two cores to run. One core for the CLI
 and the other for the channel endpoint monitor. For example, to run on
@@ -282,7 +279,7 @@ cores 0 and 1 on a system with four memory channels, issue the command:
 
 .. code-block:: console
 
-   ./build/vm_power_mgr -l 0-1 -n 4
+   ./<build_dir>/examples/dpdk-vm_power_mgr -l 0-1 -n 4
 
 After successful initialization, the VM Power Manager CLI prompt appears:
 
@@ -462,12 +459,10 @@ the following commands:
 
 .. code-block:: console
 
-   export RTE_SDK=/path/to/rte_sdk
-   export RTE_TARGET=build
-   cd ${RTE_SDK}/examples/vm_power_manager/guest_cli/
+   cd dpdk/examples/vm_power_manager/guest_cli/
    make
 
-The resulting binary is ``${RTE_SDK}/build/examples/guest_cli``.
+The resulting binary is ``dpdk/build/examples/guest_cli``.
 
 **Note**: This sample application conditionally links in the Jansson JSON
 library. Consequently, if you are using a multilib or cross-compile
@@ -498,15 +493,14 @@ To build just the ``vm_power_manager`` application using ``meson``/``ninja``:
 
 .. code-block:: console
 
-   export RTE_SDK=/path/to/rte_sdk
-   cd ${RTE_SDK}
+   cd dpdk
    meson build
    cd build
    ninja
    meson configure -Dexamples=vm_power_manager/guest_cli
    ninja
 
-The resulting binary is ``${RTE_SDK}/build/examples/guest_cli``.
+The resulting binary is ``dpdk/build/examples/guest_cli``.
 
 Running the Guest Application
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -515,14 +509,14 @@ The standard EAL command line parameters are necessary:
 
 .. code-block:: console
 
-   ./build/vm_power_mgr [EAL options] -- [guest options]
+   ./<build_dir>/examples/dpdk-vm_power_mgr [EAL options] -- [guest options]
 
 The guest example uses a channel for each lcore enabled. For example, to
 run on cores 0, 1, 2 and 3:
 
 .. code-block:: console
 
-   ./build/guest_vm_power_mgr -l 0-3
+   ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3
 
 .. _sending_policy:
 
@@ -593,7 +587,7 @@ host, use a command like the following:
 
 .. code-block:: console
 
-   ./build/guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4
+   ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4
 
 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command
 will send the policy to the host:
@@ -707,7 +701,7 @@ To start the application and configure the power policy, and send it to the host
 
 .. code-block:: console
 
- ./build/guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4
+ ./<build_dir>/examples/dpdk-guest_vm_power_mgr -l 0-3 -n 4 -- --vm-name=ubuntu --policy=BRANCH_RATIO --vcpu-list=2-4
 
 Once the VM Power Manager Guest CLI appears, issuing the 'send_policy now' command
 will send the policy to the host:
doc/guides/sample_app_ug/vmdq_dcb_forwarding.rst +4 -4
index 8e1774d9e2..c908074eb0 100644
@@ -26,13 +26,13 @@ multiple queues. When run with 8 threads, that is, with the -c FF option, each t
 As supplied, the sample application configures the VMDQ feature to have 32 pools with 4 queues each as indicated in :numref:`figure_vmdq_dcb_example`.
 The Intel® 82599 10 Gigabit Ethernet Controller NIC also supports the splitting of traffic into 16 pools of 8 queues. While the
 Intel® X710 or XL710 Ethernet Controller NICs support many configurations of VMDQ pools of 4 or 8 queues each. For simplicity, only 16
-or 32 pools is supported in this sample. And queues numbers for each VMDQ pool can be changed by setting CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM
-in config/common_* file.
+or 32 pools is supported in this sample. And queues numbers for each VMDQ pool can be changed by setting RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM
+in config/rte_config.h file.
 The nb-pools, nb-tcs and enable-rss parameters can be passed on the command line, after the EAL parameters:
 
 .. code-block:: console
 
-    ./build/vmdq_dcb [EAL options] -- -p PORTMASK --nb-pools NP --nb-tcs TC --enable-rss
+    ./<build_dir>/examples/dpdk-vmdq_dcb [EAL options] -- -p PORTMASK --nb-pools NP --nb-tcs TC --enable-rss
 
 where, NP can be 16 or 32, TC can be 4 or 8, rss is disabled by default.
 
@@ -72,7 +72,7 @@ To run the example in a linux environment:
 
 .. code-block:: console
 
-    user@target:~$ ./build/vmdq_dcb -l 0-3 -n 4 -- -p 0x3 --nb-pools 32 --nb-tcs 4
+    user@target:~$ ./<build_dir>/examples/dpdk-vmdq_dcb -l 0-3 -n 4 -- -p 0x3 --nb-pools 32 --nb-tcs 4
 
 Refer to the *DPDK Getting Started Guide* for general information on running applications and
 the Environment Abstraction Layer (EAL) options.
doc/guides/sample_app_ug/vmdq_forwarding.rst +4 -4
index c3a3439e51..a1a8e77de2 100644
@@ -24,13 +24,13 @@ multiple queues. When run with 8 threads, that is, with the -c FF option, each t
 As supplied, the sample application configures the VMDq feature to have 32 pools with 4 queues each.
 The Intel® 82599 10 Gigabit Ethernet Controller NIC also supports the splitting of traffic into 16 pools of 2 queues.
 While the Intel® X710 or XL710 Ethernet Controller NICs support many configurations of VMDq pools of 4 or 8 queues each.
-And queues numbers for each VMDq pool can be changed by setting CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM
-in config/common_* file.
+And queues numbers for each VMDq pool can be changed by setting RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM
+in config/rte_config.h file.
 The nb-pools and enable-rss parameters can be passed on the command line, after the EAL parameters:
 
 .. code-block:: console
 
-    ./build/vmdq_app [EAL options] -- -p PORTMASK --nb-pools NP --enable-rss
+    ./<build_dir>/examples/dpdk-vmdq [EAL options] -- -p PORTMASK --nb-pools NP --enable-rss
 
 where, NP can be 8, 16 or 32, rss is disabled by default.
 
@@ -56,7 +56,7 @@ To run the example in a Linux environment:
 
 .. code-block:: console
 
-    user@target:~$ ./build/vmdq_app -l 0-3 -n 4 -- -p 0x3 --nb-pools 16
+    user@target:~$ ./<build_dir>/examples/dpdk-vmdq -l 0-3 -n 4 -- -p 0x3 --nb-pools 16
 
 Refer to the *DPDK Getting Started Guide* for general information on running applications and
 the Environment Abstraction Layer (EAL) options.
doc/guides/testpmd_app_ug/run_app.rst +3 -3
index d1e4ee3e7a..ac4f0d9212 100644
@@ -20,7 +20,7 @@ They must be separated from the EAL options, shown in the previous section, with
 
 .. code-block:: console
 
-    sudo ./testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2
+    sudo ./dpdk-testpmd -l 0-3 -n 4 -- -i --portmask=0x1 --nb-cores=2
 
 The command line options are:
 
@@ -59,13 +59,13 @@ The command line options are:
 *   ``--nb-cores=N``
 
     Set the number of forwarding cores,
-    where 1 <= N <= "number of cores" or ``CONFIG_RTE_MAX_LCORE`` from the configuration file.
+    where 1 <= N <= "number of cores" or ``RTE_MAX_LCORE`` from the configuration file.
     The default value is 1.
 
 *   ``--nb-ports=N``
 
     Set the number of forwarding ports,
-    where 1 <= N <= "number of ports" on the board or ``CONFIG_RTE_MAX_ETHPORTS`` from the configuration file.
+    where 1 <= N <= "number of ports" on the board or ``RTE_MAX_ETHPORTS`` from the configuration file.
     The default value is the number of ports on the board.
 
 *   ``--coremask=0xXX``
doc/guides/testpmd_app_ug/testpmd_funcs.rst +2 -7
index 90cf252df5..6856e3b909 100644
@@ -71,7 +71,7 @@ practical or possible testpmd supports alternative methods for executing command
 
 .. code-block:: console
 
-   ./testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
+   ./dpdk-testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
    Interactive-mode selected
    CLI commands to be read from /home/ubuntu/flow-create-commands.txt
    Configuring Port 0 (socket 0)
@@ -329,7 +329,7 @@ The available information categories are:
 
 * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
 
-* ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
+* ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX.
 
 * ``noisy``: Noisy neighbor simulation.
   Simulate more realistic behavior of a guest machine engaged in receiving
@@ -379,11 +379,6 @@ Example for the io forwarding engine, with some packet drops on the tx side::
      TX-packets: 548595568      TX-dropped: 128           TX-total: 548595696
      ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-.. note::
-
-   Enabling CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES appends "CPU cycles/packet" stats, like:
-
-   CPU cycles/packet=xx.dd (total cycles=xxxx / total RX packets=xxxx) at xxx MHz clock
 
 clear fwd
 ~~~~~~~~~
Signature · 1 line
2.28.0
#200 lore raw

PATCH v4 30/31 doc: remove reference to make from tools guides

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/tools/comp_perf.rst    | 10 ++-------
 doc/guides/tools/cryptoperf.rst   | 20 +++--------------
 doc/guides/tools/pdump.rst        | 15 ++++++-------
 doc/guides/tools/proc_info.rst    |  2 +-
 doc/guides/tools/testbbdev.rst    | 36 +++++++++----------------------
 doc/guides/tools/testeventdev.rst | 21 ++++++++----------
 6 files changed, 31 insertions(+), 73 deletions(-)
doc/guides/tools/comp_perf.rst +2 -8
index ee585d1024..1b33dc4e91 100644
@@ -100,13 +100,7 @@ Application Options
 Compiling the Tool
 ------------------
 
-**Step 1: PMD setting**
-
-The ``dpdk-test-compress-perf`` tool depends on compression device drivers PMD which
-can be disabled by default in the build configuration file ``common_base``.
-The compression device drivers PMD which should be tested can be enabled by setting e.g.::
-
-   CONFIG_RTE_LIBRTE_PMD_ISAL=y
+See :doc:`../linux_gsg/build_dpdk.rst` for compilation steps.
 
 
 Running the Tool
@@ -116,5 +110,5 @@ The tool has a number of command line options. Here is the sample command line:
 
 .. code-block:: console
 
-   ./build/app/dpdk-test-compress-perf  -l 4 -- --driver-name compress_qat --input-file test.txt --seg-sz 8192
+   ./<build_dir>/app/dpdk-test-compress-perf  -l 4 -- --driver-name compress_qat --input-file test.txt --seg-sz 8192
     --compress-level 1:1:9 --num-iter 10 --extended-input-sz 1048576  --max-num-sgl-segs 16 --huffman-enc fixed
doc/guides/tools/cryptoperf.rst +3 -17
index 28b729dbda..e7ea2ba1a5 100644
@@ -33,19 +33,8 @@ the hardware accelerator fully loaded and so measure maximum throughput.
 Compiling the Application
 -------------------------
 
-**Step 1: PMD setting**
 
-The ``dpdk-test-crypto-perf`` tool depends on crypto device drivers PMD which
-are disabled by default in the build configuration file ``common_base``.
-The crypto device drivers PMD which should be tested can be enabled by setting::
-
-   CONFIG_RTE_LIBRTE_PMD_<name>=y
-
-Setting example for open ssl PMD::
-
-   CONFIG_RTE_LIBRTE_PMD_OPENSSL=y
-
-**Step 2: Linearization setting**
+**Step 1: Linearization setting**
 
 It is possible linearized input segmented packets just before crypto operation
 for devices which doesn't support scatter-gather, and allows to measure
@@ -56,13 +45,10 @@ To set on the linearization options add below definition to the
 
    #define CPERF_LINEARIZATION_ENABLE
 
-**Step 3: Build the application**
+**Step 2: Build the application**
 
-Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
-``dpdk-test-crypto-perf`` application.
+See :doc:`../linux_gsg/build_dpdk.rst` for compilation steps.
 
-Initially, the user must select a DPDK target to choose the correct target type
-and compiler options to use when building the libraries.
 The user must have all libraries, modules, updates and compilers installed
 in the system prior to this,
 as described in the earlier chapters in this Getting Started Guide.
doc/guides/tools/pdump.rst +6 -9
index 8a499c6c5b..70f03db9cc 100644
@@ -19,12 +19,9 @@ a DPDK secondary process and is capable of enabling packet capture on dpdk ports
         framework initialization code. Refer ``app/test-pmd/testpmd.c``
         code to see how this is done.
 
-      * The ``dpdk-pdump`` tool depends on libpcap based PMD which is disabled
-        by default in the build configuration files,
-        owing to an external dependency on the libpcap development files
-        which must be installed on the board.
-        Once the libpcap development files are installed, the libpcap based PMD
-        can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK.
+      * The ``dpdk-pdump`` tool depends on libpcap based PMD which must be
+        installed on the board.
+        Once the libpcap development files are installed, recompile the DPDK.
 
       * The ``dpdk-pdump`` tool runs as a DPDK secondary process. It exits when
         the primary application exits.
@@ -37,7 +34,7 @@ The tool has a number of command line options:
 
 .. code-block:: console
 
-   ./build/app/dpdk-pdump --
+   ./<build_dir>/app/dpdk-pdump --
                           [--multi]
                           --pdump '(port=<port id> | device_id=<pci id or vdev name>),
                                    (queue=<queue_id>),
@@ -120,5 +117,5 @@ Example
 
 .. code-block:: console
 
-   $ sudo ./build/app/dpdk-pdump -l 3 -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap'
-   $ sudo ./build/app/dpdk-pdump -l 3,4,5 -- --multi --pdump 'port=0,queue=*,rx-dev=/tmp/rx-1.pcap' --pdump 'port=1,queue=*,rx-dev=/tmp/rx-2.pcap'
+   $ sudo ./<build_dir>/app/dpdk-pdump -l 3 -- --pdump 'port=0,queue=*,rx-dev=/tmp/rx.pcap'
+   $ sudo ./<build_dir>/app/dpdk-pdump -l 3,4,5 -- --multi --pdump 'port=0,queue=*,rx-dev=/tmp/rx-1.pcap' --pdump 'port=1,queue=*,rx-dev=/tmp/rx-2.pcap'
doc/guides/tools/proc_info.rst +1 -1
index 0390b9c589..9772d97ef0 100644
@@ -17,7 +17,7 @@ The application has a number of command line options:
 
 .. code-block:: console
 
-   ./$(RTE_TARGET)/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
+   ./<build_dir>/app/dpdk-procinfo -- -m | [-p PORTMASK] [--stats | --xstats |
    --stats-reset | --xstats-reset] [ --show-port | --show-tm | --show-crypto |
    --show-ring[=name] | --show-mempool[=name] | --iter-mempool=name ]
 
doc/guides/tools/testbbdev.rst +10 -26
index 393c3e9d0d..1fea7e0aa4 100644
@@ -13,25 +13,10 @@ parameters passed to a python running script.
 Compiling the Application
 -------------------------
 
-**Step 1: PMD setting**
+**Build the application**
 
-The ``dpdk-test-bbdev`` tool depends on crypto device drivers PMD which
-are disabled by default in the build configuration file ``common_base``.
-The bbdevice drivers PMD which should be tested can be enabled by setting
+See :doc:`../linux_gsg/build_dpdk.rst` for compilation steps.
 
-   ``CONFIG_RTE_LIBRTE_PMD_<name>=y``
-
-Setting example for (*baseband_turbo_sw*) PMD
-
-   ``CONFIG_RTE_LIBRTE_PMD_BBDEV_TURBO_SW=y``
-
-**Step 2: Build the application**
-
-Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
-``dpdk-test-bbdev`` application.
-
-Initially, the user must select a DPDK target to choose the correct target type
-and compiler options to use when building the libraries.
 The user must have all libraries, modules, updates and compilers installed
 in the system prior to this, as described in the earlier chapters in this
 Getting Started Guide.
@@ -60,7 +45,7 @@ The following are the command-line options:
 
 ``-p TESTAPP_PATH, --testapp_path TESTAPP_PATH``
  Indicates the path to the bbdev test app. If not specified path is set based
- on *$RTE_SDK* environment variable concatenated with "*/build/app/testbbdev*".
+ on "../.." concatenated with "*/build/app/testbbdev*".
 
 ``-e EAL_PARAMS, --eal_params EAL_PARAMS``
  Specifies EAL arguments which are passed to the test app. For more details,
@@ -82,9 +67,8 @@ The following are the command-line options:
 
 ``-v TEST_VECTOR [TEST_VECTOR ...], --test_vector TEST_VECTOR [TEST_VECTOR ...]``
  Specifies paths to the test vector files. If not specified path is set based
- on *$RTE_SDK* environment variable concatenated with
- "*/app/test-bbdev/test_vectors/bbdev_null.data*" and indicates default
- data file.
+ on "../.." concatenated with "*/app/test-bbdev/test_vectors/bbdev_null.data*"
+and indicates default data file.
 
  **Example usage:**
 
@@ -259,8 +243,8 @@ They are chosen to have a good coverage across sizes and processing
 parameters while still keeping their number limited as part of sanity
 regression.
 
-Shortened tree of isg_cid-wireless_dpdk_ae with dpdk compiled for
-x86_64-native-linux-icc target:
+Shortened tree of isg_cid-wireless_dpdk_ae with dpdk compiled and output
+to the build directory:
 
 ::
 
@@ -268,7 +252,7 @@ x86_64-native-linux-icc target:
      |-- test-bbdev
          |-- test_vectors
 
- |-- x86_64-native-linux-icc
+ |-- build
      |-- app
          |-- testbbdev
 
@@ -277,7 +261,7 @@ All bbdev devices
 
 .. code-block:: console
 
-  ./test-bbdev.py -p ../../x86_64-native-linux-icc/app/testbbdev
+  ./test-bbdev.py -p ../../build/app/dpdk-test-bbdev
   -v turbo_dec_default.data
 
 It runs all available tests using the test vector filled based on
@@ -291,7 +275,7 @@ baseband turbo_sw device
 
 .. code-block:: console
 
-  ./test-bbdev.py -p ../../x86_64-native-linux-icc/app/testbbdev
+  ./test-bbdev.py -p ../../build/app/dpdk-test-bbdev
   -e="--vdev=baseband_turbo_sw" -t 120 -c validation
   -v ./test_vectors/* -n 64 -b 8 32
 
doc/guides/tools/testeventdev.rst +9 -12
index 2ed67a6340..00387ec4ed 100644
@@ -15,11 +15,8 @@ Compiling the Application
 
 **Build the application**
 
-Execute the ``dpdk-setup.sh`` script to build the DPDK library together with the
-``dpdk-test-eventdev`` application.
+See :doc:`../linux_gsg/build_dpdk.rst` for compilation steps.
 
-Initially, the user must select a DPDK target to choose the correct target type
-and compiler options to use when building the libraries.
 The user must have all libraries, modules, updates and compilers installed
 in the system prior to this,
 as described in the earlier chapters in this Getting Started Guide.
@@ -251,7 +248,7 @@ Example command to run order queue test:
 
 .. code-block:: console
 
-   sudo build/app/dpdk-test-eventdev --vdev=event_sw0 -- \
+   sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_sw0 -- \
                 --test=order_queue --plcores 1 --wlcores 2,3
 
 
@@ -314,7 +311,7 @@ Example command to run order ``all types queue`` test:
 
 .. code-block:: console
 
-   sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
+   sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_octeontx -- \
                         --test=order_atq --plcores 1 --wlcores 2,3
 
 
@@ -414,7 +411,7 @@ Example command to run perf queue test:
 
 .. code-block:: console
 
-   sudo build/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
+   sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x1 --vdev=event_sw0 -- \
         --test=perf_queue --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
 
 Example command to run perf queue test with ethernet ports:
@@ -428,7 +425,7 @@ Example command to run perf queue test with event timer adapter:
 
 .. code-block:: console
 
-   sudo  build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
+   sudo  <build_dir>/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
                 --wlcores 4 --plcores 12 --test perf_queue --stlist=a \
                 --prod_type_timerdev --fwd_latency
 
@@ -514,14 +511,14 @@ Example command to run perf ``all types queue`` test:
 
 .. code-block:: console
 
-   sudo build/app/dpdk-test-eventdev --vdev=event_octeontx -- \
+   sudo <build_dir>/app/dpdk-test-eventdev --vdev=event_octeontx -- \
                 --test=perf_atq --plcores=2 --wlcore=3 --stlist=p --nb_pkts=0
 
 Example command to run perf ``all types queue`` test with event timer adapter:
 
 .. code-block:: console
 
-   sudo  build/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
+   sudo  <build_dir>/app/dpdk-test-eventdev --vdev="event_octeontx" -- \
                 --wlcores 4 --plcores 12 --test perf_atq --verbose 20 \
                 --stlist=a --prod_type_timerdev --fwd_latency
 
@@ -633,7 +630,7 @@ Example command to run pipeline queue test:
 
 .. code-block:: console
 
-    sudo build/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
+    sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
         --test=pipeline_queue --wlcore=1 --prod_type_ethdev --stlist=a
 
 
@@ -725,5 +722,5 @@ Example command to run pipeline queue test:
 
 .. code-block:: console
 
-    sudo build/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
+    sudo <build_dir>/app/dpdk-test-eventdev -c 0xf -s 0x8 --vdev=event_sw0 -- \
         --test=pipeline_atq --wlcore=1 --prod_type_ethdev --stlist=a
Signature · 1 line
2.28.0
#201 lore raw

PATCH v4 31/31 doc: remove references to make from contributing guide

In reply to Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/contributing/design.rst        | 127 ++--------------------
 doc/guides/contributing/documentation.rst |  31 +-----
 2 files changed, 13 insertions(+), 145 deletions(-)
doc/guides/contributing/design.rst +7 -120
index 5fe7f63942..6ce0de97ac 100644
@@ -21,7 +21,7 @@ A file located in a subdir of "linux" is specific to this execution environment.
 
 When absolutely necessary, there are several ways to handle specific code:
 
-* Use a ``#ifdef`` with the CONFIG option in the C code.
+* Use a ``#ifdef`` with a build definition macro in the C code.
   This can be done when the differences are small and they can be embedded in the same C file:
 
   .. code-block:: c
@@ -32,30 +32,22 @@ When absolutely necessary, there are several ways to handle specific code:
      titi();
      #endif
 
-* Use the CONFIG option in the Makefile. This is done when the differences are more significant.
-  In this case, the code is split into two separate files that are architecture or environment specific.
-  This should only apply inside the EAL library.
-
-.. note::
-
-   As in the linux kernel, the ``CONFIG_`` prefix is not used in C code.
-   This is only needed in Makefiles or shell scripts.
 
 Per Architecture Sources
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-The following config options can be used:
+The following macro options can be used:
 
-* ``CONFIG_RTE_ARCH`` is a string that contains the name of the architecture.
-* ``CONFIG_RTE_ARCH_I686``, ``CONFIG_RTE_ARCH_X86_64``, ``CONFIG_RTE_ARCH_X86_64_32`` or ``CONFIG_RTE_ARCH_PPC_64`` are defined only if we are building for those architectures.
+* ``RTE_ARCH`` is a string that contains the name of the architecture.
+* ``RTE_ARCH_I686``, ``RTE_ARCH_X86_64``, ``RTE_ARCH_X86_64_32`` or ``RTE_ARCH_PPC_64`` are defined only if we are building for those architectures.
 
 Per Execution Environment Sources
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The following config options can be used:
+The following macro options can be used:
 
-* ``CONFIG_RTE_EXEC_ENV`` is a string that contains the name of the executive environment.
-* ``CONFIG_RTE_EXEC_ENV_FREEBSD`` or ``CONFIG_RTE_EXEC_ENV_LINUX`` are defined only if we are building for this execution environment.
+* ``RTE_EXEC_ENV`` is a string that contains the name of the executive environment.
+* ``RTE_EXEC_ENV_FREEBSD`` or ``RTE_EXEC_ENV_LINUX`` are defined only if we are building for this execution environment.
 
 Mbuf features
 -------------
@@ -73,111 +65,6 @@ Adding a new static field or flag must be an exception matching many criteria
 like (non exhaustive): wide usage, performance, size.
 
 
-Library Statistics
-------------------
-
-Description
-~~~~~~~~~~~
-
-This document describes the guidelines for DPDK library-level statistics counter
-support. This includes guidelines for turning library statistics on and off and
-requirements for preventing ABI changes when implementing statistics.
-
-
-Mechanism to allow the application to turn library statistics on and off
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Each library that maintains statistics counters should provide a single build
-time flag that decides whether the statistics counter collection is enabled or
-not. This flag should be exposed as a variable within the DPDK configuration
-file. When this flag is set, all the counters supported by current library are
-collected for all the instances of every object type provided by the library.
-When this flag is cleared, none of the counters supported by the current library
-are collected for any instance of any object type provided by the library:
-
-.. code-block:: console
-
-   # DPDK file config/common_linux, config/common_freebsd, etc.
-   CONFIG_RTE_<LIBRARY_NAME>_STATS_COLLECT=y/n
-
-The default value for this DPDK configuration file variable (either "yes" or
-"no") is decided by each library.
-
-
-Prevention of ABI changes due to library statistics support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The layout of data structures and prototype of functions that are part of the
-library API should not be affected by whether the collection of statistics
-counters is turned on or off for the current library. In practical terms, this
-means that space should always be allocated in the API data structures for
-statistics counters and the statistics related API functions are always built
-into the code, regardless of whether the statistics counter collection is turned
-on or off for the current library.
-
-When the collection of statistics counters for the current library is turned
-off, the counters retrieved through the statistics related API functions should
-have a default value of zero.
-
-
-Motivation to allow the application to turn library statistics on and off
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-It is highly recommended that each library provides statistics counters to allow
-an application to monitor the library-level run-time events. Typical counters
-are: number of packets received/dropped/transmitted, number of buffers
-allocated/freed, number of occurrences for specific events, etc.
-
-However, the resources consumed for library-level statistics counter collection
-have to be spent out of the application budget and the counters collected by
-some libraries might not be relevant to the current application. In order to
-avoid any unwanted waste of resources and/or performance impacts, the
-application should decide at build time whether the collection of library-level
-statistics counters should be turned on or off for each library individually.
-
-Library-level statistics counters can be relevant or not for specific
-applications:
-
-* For Application A, counters maintained by Library X are always relevant and
-  the application needs to use them to implement certain features, such as traffic
-  accounting, logging, application-level statistics, etc. In this case,
-  the application requires that collection of statistics counters for Library X is
-  always turned on.
-
-* For Application B, counters maintained by Library X are only useful during the
-  application debug stage and are not relevant once debug phase is over. In this
-  case, the application may decide to turn on the collection of Library X
-  statistics counters during the debug phase and at a later stage turn them off.
-
-* For Application C, counters maintained by Library X are not relevant at all.
-  It might be that the application maintains its own set of statistics counters
-  that monitor a different set of run-time events (e.g. number of connection
-  requests, number of active users, etc). It might also be that the application
-  uses multiple libraries (Library X, Library Y, etc) and it is interested in the
-  statistics counters of Library Y, but not in those of Library X. In this case,
-  the application may decide to turn the collection of statistics counters off for
-  Library X and on for Library Y.
-
-The statistics collection consumes a certain amount of CPU resources (cycles,
-cache bandwidth, memory bandwidth, etc) that depends on:
-
-* Number of libraries used by the current application that have statistics
-  counters collection turned on.
-
-* Number of statistics counters maintained by each library per object type
-  instance (e.g. per port, table, pipeline, thread, etc).
-
-* Number of instances created for each object type supported by each library.
-
-* Complexity of the statistics logic collection for each counter: when only
-  some occurrences of a specific event are valid, additional logic is typically
-  needed to decide whether the current occurrence of the event should be counted
-  or not. For example, in the event of packet reception, when only TCP packets
-  with destination port within a certain range should be recorded, conditional
-  branches are usually required. When processing a burst of packets that have been
-  validated for header integrity, counting the number of bits set in a bitmask
-  might be needed.
-
 PF and VF Considerations
 ------------------------
 
doc/guides/contributing/documentation.rst +6 -25
index 375ea64ba8..768453126f 100644
@@ -222,25 +222,14 @@ Build commands
 ~~~~~~~~~~~~~~
 
 The documentation is built using the standard DPDK build system.
-Some examples are shown below:
 
-* Generate all the documentation targets::
+To enable doc building::
 
-     make doc
+   meson configure -Denable_docs=true
 
-* Generate the Doxygen API documentation in Html::
+See :doc:`../linux_gsg/build_dpdk` for more detail on compiling DPDK with meson.
 
-     make doc-api-html
-
-* Generate the guides documentation in Html::
-
-     make doc-guides-html
-
-* Generate the guides documentation in Pdf::
-
-     make doc-guides-pdf
-
-The output of these commands is generated in the ``build`` directory::
+The output is generated in the ``build`` directory::
 
    build/doc
          |-- html
@@ -255,10 +244,6 @@ The output of these commands is generated in the ``build`` directory::
 
    Make sure to fix any Sphinx or Doxygen warnings when adding or updating documentation.
 
-The documentation output files can be removed as follows::
-
-   make doc-clean
-
 
 Document Guidelines
 -------------------
@@ -308,7 +293,7 @@ Line Length
   Long literal command lines can be shown wrapped with backslashes. For
   example::
 
-     testpmd -l 2-3 -n 4 \
+     dpdk-testpmd -l 2-3 -n 4 \
              --vdev=virtio_user0,path=/dev/vhost-net,queues=2,queue_size=1024 \
              -- -i --tx-offloads=0x0000002c --enable-lro --txq=2 --rxq=2 \
              --txd=1024 --rxd=1024
@@ -460,7 +445,7 @@ Code and Literal block sections
   For long literal lines that exceed that limit try to wrap the text at sensible locations.
   For example a long command line could be documented like this and still work if copied directly from the docs::
 
-     build/app/testpmd -l 0-2 -n3 --vdev=net_pcap0,iface=eth0     \
+     ./<build_dir>/app/dpdk-testpmd -l 0-2 -n3 --vdev=net_pcap0,iface=eth0    \
                                --vdev=net_pcap1,iface=eth1     \
                                -- -i --nb-cores=2 --nb-ports=2 \
                                   --total-num-mbufs=2048
@@ -743,9 +728,5 @@ The following are some guidelines for use of Doxygen in the DPDK API documentati
      /** Array of physical page addresses for the mempool buffer. */
      phys_addr_t elt_pa[MEMPOOL_PG_NUM_DEFAULT];
 
-* Check for Doxygen warnings in new code by checking the API documentation build::
-
-     make doc-api-html >/dev/null
-
 * Read the rendered section of the documentation that you have added for correctness, clarity and consistency
   with the surrounding text.
Signature · 1 line
2.28.0
#202 lore raw

Re: [dpdk-dev] [PATCH v4 31/31] doc: remove references to make from contributing guide

Quoted 11 lines · Thomas Monjalon

From: Ciara Power <[email protected]>

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
doc/guides/contributing/design.rst | 127 ++-------------------- doc/guides/contributing/documentation.rst | 31 +-----

2 files changed, 13 insertions(+), 145 deletions(-)

As reported by David, an update is missing in patches.rst:
devtools/test-build.sh reference should be removed

#203 lore raw
In reply to Thomas Monjalon
Quoted 11 lines · Thomas Monjalon

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

The last 18 commits (devtools, app and doc) are pending for more reviews, especially because the doc rework is still in progress. This is a big change which requires to be split but must be completed soon.
*All*, please make the documentation update your highest priority. I will be reluctant to merge some driver changes if the related doc is not updated.

Thanks for the apply of the code patches, I think it will make all our subsequent patch submissions a bit cleaner.

In terms of docs, I believe the Linux and FreeBSD GSG guides to be ready for merge, or if not 100% they are at least good enough IMHO to be applied now and have some minor tweaks in subsequent patches later. While I'm sure the Linux GSG could do with more major rework, that should be separate from the doc updates in this patch.

/Bruce

#204 lore raw

08/09/2020 10:16, Bruce Richardson:

Quoted 12 lines · Thomas Monjalon
Quoted 11 lines

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

The last 18 commits (devtools, app and doc) are pending for more reviews, especially because the doc rework is still in progress. This is a big change which requires to be split but must be completed soon.
*All*, please make the documentation update your highest priority. I will be reluctant to merge some driver changes if the related doc is not updated.

Quoted 8 lines

Thanks for the apply of the code patches, I think it will make all our subsequent patch submissions a bit cleaner.

In terms of docs, I believe the Linux and FreeBSD GSG guides to be ready for merge, or if not 100% they are at least good enough IMHO to be applied now and have some minor tweaks in subsequent patches later. While I'm sure the Linux GSG could do with more major rework, that should be separate from the doc updates in this patch.

Of course I am not expecting any major rework in these patches, but I don't want to apply clean-up half done,
which can drop some relevant informations or introduce mistakes.

I will review the Linux and FreeBSD user guides first, as you suggest.

#205 lore raw
Quoted 23 lines · Thomas Monjalon

08/09/2020 10:16, Bruce Richardson:

Quoted 12 lines · Thomas Monjalon
Quoted 11 lines

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

The last 18 commits (devtools, app and doc) are pending for more reviews, especially because the doc rework is still in progress. This is a big change which requires to be split but must be completed soon.
*All*, please make the documentation update your highest priority. I will be reluctant to merge some driver changes if the related doc is not updated.

Quoted 8 lines

Thanks for the apply of the code patches, I think it will make all our subsequent patch submissions a bit cleaner.

In terms of docs, I believe the Linux and FreeBSD GSG guides to be ready for merge, or if not 100% they are at least good enough IMHO to be applied now and have some minor tweaks in subsequent patches later. While I'm sure the Linux GSG could do with more major rework, that should be separate from the doc updates in this patch.

Quoted 5 lines

Of course I am not expecting any major rework in these patches, but I don't want to apply clean-up half done,
which can drop some relevant informations or introduce mistakes.

I will review the Linux and FreeBSD user guides first, as you suggest.

I could not find a patch in patchwork for app/test-bbdev/test-bbdev.py which still references RTE_SDK and RTE_TARGET.

Signature · 1 line
David Marchand
#206 lore raw

Hi David,

Quoted 38 lines

-----Original Message-----
From: David Marchand <[email protected]>
Sent: Tuesday 15 September 2020 15:03
To: Thomas Monjalon <[email protected]>; Chautru, Nicolas <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>; Power, Ciara <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

Quoted 27 lines · Thomas Monjalon

08/09/2020 10:16, Bruce Richardson:

Quoted 12 lines · Thomas Monjalon
Quoted 11 lines

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

The last 18 commits (devtools, app and doc) are pending for more reviews, especially because the doc rework is still in progress. This is a big change which requires to be split but must be completed soon.
*All*, please make the documentation update your highest priority. I will be reluctant to merge some driver changes if the related doc is not updated.

Quoted 8 lines

Thanks for the apply of the code patches, I think it will make all our subsequent patch submissions a bit cleaner.

In terms of docs, I believe the Linux and FreeBSD GSG guides to be ready for merge, or if not 100% they are at least good enough IMHO to be applied now and have some minor tweaks in subsequent patches later. While I'm sure the Linux GSG could do with more major rework, that should be separate from the doc updates in this patch.

Of course I am not expecting any major rework in these patches, but I don't want to apply clean-up half done, which can drop some relevant informations or introduce mistakes.

Quoted 8 lines
Quoted 1 line

I will review the Linux and FreeBSD user guides first, as you suggest.

I could not find a patch in patchwork for app/test-bbdev/test-bbdev.py which still references RTE_SDK and RTE_TARGET.

--
David Marchand

Changes to test-bbdev.py were made in patch 15: https://patchwork.dpdk.org/patch/76796/ to remove the references to RTE_SDK and RTE_TARGET.

Thanks,
Ciara

#207 lore raw

15/09/2020 17:08, Power, Ciara:

Quoted 47 lines

Hi David,

Quoted 44 lines

-----Original Message-----
From: David Marchand <[email protected]>
Sent: Tuesday 15 September 2020 15:03
To: Thomas Monjalon <[email protected]>; Chautru, Nicolas <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>; Power, Ciara <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

Quoted 23 lines · Thomas Monjalon

08/09/2020 10:16, Bruce Richardson:

Quoted 12 lines · Thomas Monjalon
Quoted 11 lines

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

The last 18 commits (devtools, app and doc) are pending for more reviews, especially because the doc rework is still in progress. This is a big change which requires to be split but must be completed soon.
*All*, please make the documentation update your highest priority. I will be reluctant to merge some driver changes if the related doc is not updated.

Quoted 8 lines

Thanks for the apply of the code patches, I think it will make all our subsequent patch submissions a bit cleaner.

In terms of docs, I believe the Linux and FreeBSD GSG guides to be ready for merge, or if not 100% they are at least good enough IMHO to be applied now and have some minor tweaks in subsequent patches later. While I'm sure the Linux GSG could do with more major rework, that should be separate from the doc updates in this patch.

Quoted 5 lines

Of course I am not expecting any major rework in these patches, but I don't want to apply clean-up half done, which can drop some relevant informations or introduce mistakes.

I will review the Linux and FreeBSD user guides first, as you suggest.

I could not find a patch in patchwork for app/test-bbdev/test-bbdev.py which still references RTE_SDK and RTE_TARGET.

Quoted 5 lines
Quoted 2 lines

--
David Marchand

Changes to test-bbdev.py were made in patch 15: https://patchwork.dpdk.org/patch/76796/ to remove the references to RTE_SDK and RTE_TARGET.

I did not merge this patch because it is hardcoding "build" as a directory. I'm sure we can do better.

#208 lore raw
Quoted 67 lines

-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Tuesday, September 15, 2020 4:44 PM
To: David Marchand <[email protected]>; Chautru, Nicolas <[email protected]>; Power, Ciara <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

15/09/2020 17:08, Power, Ciara:

Quoted 22 lines

Hi David,

Quoted 19 lines

-----Original Message-----
From: David Marchand <[email protected]>
Sent: Tuesday 15 September 2020 15:03
To: Thomas Monjalon <[email protected]>; Chautru, Nicolas <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>; Power, Ciara <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

Quoted 8 lines · Thomas Monjalon

08/09/2020 10:16, Bruce Richardson:

Quoted 6 lines · Thomas Monjalon
Quoted 5 lines

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

The last 18 commits (devtools, app and doc) are pending for more reviews, especially because the doc rework is still in

progress.

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

This is a big change which requires to be split but must be completed soon.
*All*, please make the documentation update your highest

priority.

Quoted 11 lines
Quoted 11 lines
Quoted 11 lines
Quoted 11 lines
Quoted 3 lines

I will be reluctant to merge some driver changes if the related doc is not updated.

Thanks for the apply of the code patches, I think it will make all our subsequent patch submissions a bit cleaner.

In terms of docs, I believe the Linux and FreeBSD GSG guides to be ready for merge, or if not 100% they are at least good enough IMHO to be applied now and have some minor tweaks in subsequent patches later. While I'm sure the Linux GSG could do with more major rework, that should be separate from the doc updates in this

patch.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

Of course I am not expecting any major rework in these patches, but I don't want to apply clean-up half done, which can drop some relevant informations or introduce mistakes.

I will review the Linux and FreeBSD user guides first, as you

suggest.

Quoted 3 lines
Quoted 3 lines

I could not find a patch in patchwork for app/test-bbdev/test-bbdev.py which still references RTE_SDK and

RTE_TARGET.

Quoted 6 lines
Quoted 4 lines

--
David Marchand

Quoted 8 lines
Quoted 1 line

Changes to test-bbdev.py were made in patch 15:

https://patchwork.dpdk.org/patch/76796/ to remove the references to RTE_SDK and RTE_TARGET.

I did not merge this patch because it is hardcoding "build" as a directory.
I'm sure we can do better.

We probably can, but is it really worth holding up the patch over something as trivial as that? It is really likely to cause people issues?

#209 lore raw

15/09/2020 17:57, Richardson, Bruce:

Quoted 70 lines
Quoted 70 lines

-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Tuesday, September 15, 2020 4:44 PM
To: David Marchand <[email protected]>; Chautru, Nicolas <[email protected]>; Power, Ciara <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

15/09/2020 17:08, Power, Ciara:

Quoted 22 lines

Hi David,

Quoted 19 lines

-----Original Message-----
From: David Marchand <[email protected]>
Sent: Tuesday 15 September 2020 15:03
To: Thomas Monjalon <[email protected]>; Chautru, Nicolas <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>; Power, Ciara <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

Quoted 8 lines · Thomas Monjalon

08/09/2020 10:16, Bruce Richardson:

Quoted 6 lines · Thomas Monjalon
Quoted 5 lines

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

The last 18 commits (devtools, app and doc) are pending for more reviews, especially because the doc rework is still in

progress.

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

This is a big change which requires to be split but must be completed soon.
*All*, please make the documentation update your highest

priority.

Quoted 11 lines
Quoted 11 lines
Quoted 11 lines
Quoted 11 lines
Quoted 3 lines

I will be reluctant to merge some driver changes if the related doc is not updated.

Thanks for the apply of the code patches, I think it will make all our subsequent patch submissions a bit cleaner.

In terms of docs, I believe the Linux and FreeBSD GSG guides to be ready for merge, or if not 100% they are at least good enough IMHO to be applied now and have some minor tweaks in subsequent patches later. While I'm sure the Linux GSG could do with more major rework, that should be separate from the doc updates in this

patch.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

Of course I am not expecting any major rework in these patches, but I don't want to apply clean-up half done, which can drop some relevant informations or introduce mistakes.

I will review the Linux and FreeBSD user guides first, as you

suggest.

Quoted 3 lines
Quoted 3 lines

I could not find a patch in patchwork for app/test-bbdev/test-bbdev.py which still references RTE_SDK and

RTE_TARGET.

Quoted 7 lines
Quoted 4 lines

--
David Marchand

Changes to test-bbdev.py were made in patch 15:

https://patchwork.dpdk.org/patch/76796/ to remove the references to RTE_SDK and RTE_TARGET.

Quoted 6 lines
Quoted 4 lines

I did not merge this patch because it is hardcoding "build" as a directory.
I'm sure we can do better.

We probably can, but is it really worth holding up the patch over something as trivial as that? It is really likely to cause people issues?

I give one more week to Nicolas to better fix this script. If not, I will merge that patch as is.

#210 lore raw

Hi,

Quoted 88 lines

From: Thomas Monjalon <[email protected]>
Sent: Tuesday, September 15, 2020 9:11 AM
To: David Marchand <[email protected]>; Chautru, Nicolas <[email protected]>; Power, Ciara <[email protected]>; Richardson, Bruce <[email protected]>
Cc: dev <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

15/09/2020 17:57, Richardson, Bruce:

Quoted 29 lines
Quoted 29 lines

-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Tuesday, September 15, 2020 4:44 PM
To: David Marchand <[email protected]>; Chautru, Nicolas <[email protected]>; Power, Ciara <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

15/09/2020 17:08, Power, Ciara:

Quoted 18 lines

Hi David,

Quoted 15 lines

-----Original Message-----
From: David Marchand <[email protected]>
Sent: Tuesday 15 September 2020 15:03
To: Thomas Monjalon <[email protected]>; Chautru, Nicolas <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>; Power, Ciara <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

Quoted 3 lines · Thomas Monjalon

08/09/2020 10:16, Bruce Richardson:

Quoted 1 line

On Tue, Sep 08, 2020 at 12:06:40AM +0200, Thomas Monjalon

Quoted 49 lines · wrote:
Quoted 48 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

The last 18 commits (devtools, app and doc) are pending for more reviews, especially because the doc rework is still in

progress.

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

This is a big change which requires to be split but must be completed soon.
*All*, please make the documentation update your highest

priority.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 3 lines

I will be reluctant to merge some driver changes if the related doc is not updated.

Thanks for the apply of the code patches, I think it will make all our subsequent patch submissions a bit cleaner.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

In terms of docs, I believe the Linux and FreeBSD GSG guides to be ready for merge, or if not 100% they are at least good enough IMHO to be applied now and have some minor tweaks in subsequent patches later. While I'm sure the Linux GSG could do with more major rework, that should be separate from the doc updates in this

patch.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

Of course I am not expecting any major rework in these patches, but I don't want to apply clean-up half done, which can drop some relevant informations or introduce mistakes.

I will review the Linux and FreeBSD user guides first, as you

suggest.

Quoted 3 lines
Quoted 3 lines

I could not find a patch in patchwork for app/test-bbdev/test-bbdev.py which still references RTE_SDK and

RTE_TARGET.

Quoted 7 lines
Quoted 4 lines

--
David Marchand

Changes to test-bbdev.py were made in patch 15:

https://patchwork.dpdk.org/patch/76796/ to remove the references to RTE_SDK and RTE_TARGET.

I did not merge this patch because it is hardcoding "build" as a directory.
I'm sure we can do better.

Quoted 6 lines
Quoted 1 line

We probably can, but is it really worth holding up the patch over something as

trivial as that? It is really likely to cause people issues?

I give one more week to Nicolas to better fix this script. If not, I will merge that patch as is.

Hi Thomas, Ciara,
I had raised that concern a couple of weeks ago but I was personally satisfied with document pointing to build as default staging build directory and seeing limited reason in practice for it to be impactful for bbdev users. Also the argument to the script -p can be used to bypass default path to any location.
See reply here https://patches.dpdk.org/patch/76426/
The only request I had was to change the default name of the binary (mentioned on same link above) and I don't see that change being made (I may just miss the superseding patch though)

Thanks
Nic

#211 lore raw

15/09/2020 18:39, Chautru, Nicolas:

Quoted 97 lines

Hi,

Quoted 88 lines

From: Thomas Monjalon <[email protected]>
Sent: Tuesday, September 15, 2020 9:11 AM
To: David Marchand <[email protected]>; Chautru, Nicolas <[email protected]>; Power, Ciara <[email protected]>; Richardson, Bruce <[email protected]>
Cc: dev <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

15/09/2020 17:57, Richardson, Bruce:

Quoted 29 lines
Quoted 29 lines

-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Tuesday, September 15, 2020 4:44 PM
To: David Marchand <[email protected]>; Chautru, Nicolas <[email protected]>; Power, Ciara <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

15/09/2020 17:08, Power, Ciara:

Quoted 18 lines

Hi David,

Quoted 15 lines

-----Original Message-----
From: David Marchand <[email protected]>
Sent: Tuesday 15 September 2020 15:03
To: Thomas Monjalon <[email protected]>; Chautru, Nicolas <[email protected]>
Cc: Richardson, Bruce <[email protected]>; dev <[email protected]>; Power, Ciara <[email protected]>
Subject: Re: [PATCH v4 00/31] remove make support in DPDK

Quoted 3 lines · Thomas Monjalon

08/09/2020 10:16, Bruce Richardson:

Quoted 1 line

On Tue, Sep 08, 2020 at 12:06:40AM +0200, Thomas Monjalon

Quoted 49 lines · wrote:
Quoted 48 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines
Quoted 5 lines

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

The last 18 commits (devtools, app and doc) are pending for more reviews, especially because the doc rework is still in

progress.

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

This is a big change which requires to be split but must be completed soon.
*All*, please make the documentation update your highest

priority.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 3 lines

I will be reluctant to merge some driver changes if the related doc is not updated.

Thanks for the apply of the code patches, I think it will make all our subsequent patch submissions a bit cleaner.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

In terms of docs, I believe the Linux and FreeBSD GSG guides to be ready for merge, or if not 100% they are at least good enough IMHO to be applied now and have some minor tweaks in subsequent patches later. While I'm sure the Linux GSG could do with more major rework, that should be separate from the doc updates in this

patch.

Quoted 6 lines
Quoted 6 lines
Quoted 6 lines

Of course I am not expecting any major rework in these patches, but I don't want to apply clean-up half done, which can drop some relevant informations or introduce mistakes.

I will review the Linux and FreeBSD user guides first, as you

suggest.

Quoted 3 lines
Quoted 3 lines

I could not find a patch in patchwork for app/test-bbdev/test-bbdev.py which still references RTE_SDK and

RTE_TARGET.

Quoted 7 lines
Quoted 4 lines

--
David Marchand

Changes to test-bbdev.py were made in patch 15:

https://patchwork.dpdk.org/patch/76796/ to remove the references to RTE_SDK and RTE_TARGET.

I did not merge this patch because it is hardcoding "build" as a directory.
I'm sure we can do better.

Quoted 6 lines
Quoted 1 line

We probably can, but is it really worth holding up the patch over something as

trivial as that? It is really likely to cause people issues?

I give one more week to Nicolas to better fix this script. If not, I will merge that patch as is.

Quoted 5 lines

Hi Thomas, Ciara,
I had raised that concern a couple of weeks ago but I was personally satisfied with document pointing to build as default staging build directory and seeing limited reason in practice for it to be impactful for bbdev users. Also the argument to the script -p can be used to bypass default path to any location.
See reply here https://patches.dpdk.org/patch/76426/
The only request I had was to change the default name of the binary (mentioned on same link above) and I don't see that change being made (I may just miss the superseding patch though)

You're right, I remember it was the other reason for not merging.

In any case, I will wait for Ack from Nicolas.

#212 lore raw
In reply to Power, Ciara
Quoted 3 lines · Ciara
Quoted 2 lines

I could not find a patch in patchwork for app/test-bbdev/test-bbdev.py which still references RTE_SDK and RTE_TARGET.

Changes to test-bbdev.py were made in patch 15: https://patchwork.dpdk.org/patch/76796/ to remove the references to RTE_SDK and RTE_TARGET.

Err, indeed, and I thought I had checked this series... Thanks Ciara.

Signature · 1 line
David Marchand
#213 lore raw
In reply to Thomas Monjalon
Quoted 4 lines · Thomas Monjalon

The first 13 commits of this series are pushed to the main branch, making the make-based build an old story.

[snip]

Quoted 3 lines
 doc/guides/rawdevs/octeontx2_ep.rst           |    8 -
 doc/guides/rel_notes/deprecation.rst          |    7 -
 doc/guides/sample_app_ug/bbdev_app.rst        |   34 +-

[snip]

Patch 11 applied on the main branch dropped the deprecation notice but we are missing an update in the 20.11 release notes to announce the removal.
Can this be fixed with the rest of the patches?

Thanks.

Signature · 1 line
David Marchand
#214 lore raw

v5 cover remove make support in DPDK

In reply to Ciara Power

This patchset includes the remaining 18 patches that were not merged along with the others in v4, pending rework and more review. *All*, please make the documentation update your highest priority.

v5:
- Added patch to update cheatsheet.
- Added patch to update release notes.
- Fixed outstanding comments on v3/v4.
v4: rearrange commits and fix as commented
v3: Fixed comments on v2.
v2:
- Fixed comments on v1.
- Removed additional make references.
- Added some meson replacements where necessary.
- Added dummy root Makefile.

As previously decided [1] and communicated via deprecation notice [2], the make build system is to be removed in the 20.11 release.

This patchset removes support for compiling DPDK with the legacy make build system. Some make support is maintained for example applications, where pkg-config is used rather than the legacy make method.

References to the make build system are removed from all documentation, please review to see if replacement meson instructions are needed in some cases.

[1] https://mails.dpdk.org/archives/dev/2020-April/162839.html
[2] http://git.dpdk.org/dpdk/commit/?id=a5449d78d1413e7bd1d66f6e70884e46cfb5e673

Ciara Power (19):
devtools: remove legacy flags from includes check
app: remove references to make-based config
doc: remove references to make from Linux guide
doc: remove references to make from FreeBSD guide
doc: remove references to make from howto guides
doc: remove references to make from prog guide
doc: remove references to make from platforms guides
doc: remove references to make from mempool guide
doc: remove references to make from NICs guides
doc: remove references to make from vdpadevs guides
doc: remove references to make from bbdevs guides
doc: remove references to make from cryptodevs guides
doc: remove references to make from compressdevs guides
doc: remove references to make from eventdevs guides
doc: remove references to make from rawdevs guides
doc: remove references to make from app guides
doc: remove reference to make from tools guides
doc: remove references to make from contributing guide
doc: add to release notes to reflect removal of make

Kevin Laatz (1):
doc: update patch cheatsheet to use meson

 app/test-bbdev/test-bbdev.py                  |  13 +-
 app/test/test_cryptodev.c                     |  89 +--
 app/test/test_cryptodev_asym.c                |  18 +-
 devtools/check-includes.sh                    |  11 +-
 doc/guides/bbdevs/fpga_5gnr_fec.rst           |   7 +-
 doc/guides/bbdevs/fpga_lte_fec.rst            |   7 +-
 doc/guides/bbdevs/turbo_sw.rst                |  23 +-
 doc/guides/compressdevs/isal.rst              |   4 -
 doc/guides/compressdevs/octeontx.rst          |  24 +-
 doc/guides/compressdevs/zlib.rst              |   4 -
 doc/guides/contributing/design.rst            |  41 +-
 doc/guides/contributing/documentation.rst     |  31 +-
 .../contributing/img/patch_cheatsheet.svg     | 582 ++++++++----------
 doc/guides/contributing/patches.rst           |   6 +-
 doc/guides/cryptodevs/aesni_gcm.rst           |   4 +-
 doc/guides/cryptodevs/aesni_mb.rst            |   4 +-
 doc/guides/cryptodevs/armv8.rst               |   3 -
 doc/guides/cryptodevs/caam_jr.rst             |  30 -
 doc/guides/cryptodevs/ccp.rst                 |  14 +-
 doc/guides/cryptodevs/dpaa2_sec.rst           |  25 -
 doc/guides/cryptodevs/dpaa_sec.rst            |  25 -
 doc/guides/cryptodevs/kasumi.rst              |  11 +-
 doc/guides/cryptodevs/mvsam.rst               |  10 +-
 doc/guides/cryptodevs/nitrox.rst              |   7 -
 doc/guides/cryptodevs/null.rst                |   2 +-
 doc/guides/cryptodevs/octeontx.rst            |  12 +-
 doc/guides/cryptodevs/octeontx2.rst           |   8 +-
 doc/guides/cryptodevs/openssl.rst             |   6 +-
 doc/guides/cryptodevs/qat.rst                 |  67 +-
 doc/guides/cryptodevs/scheduler.rst           |   8 -
 doc/guides/cryptodevs/snow3g.rst              |  10 +-
 doc/guides/cryptodevs/virtio.rst              |  20 +-
 doc/guides/cryptodevs/zuc.rst                 |  10 +-
 doc/guides/eventdevs/dpaa.rst                 |  20 -
 doc/guides/eventdevs/dpaa2.rst                |  20 -
 doc/guides/eventdevs/octeontx.rst             |  24 -
 doc/guides/eventdevs/octeontx2.rst            |   8 -
 doc/guides/freebsd_gsg/build_dpdk.rst         |   2 +-
 doc/guides/howto/lm_bond_virtio_sriov.rst     |   4 +-
 doc/guides/howto/lm_virtio_vhost_user.rst     |   4 +-
 doc/guides/howto/packet_capture_framework.rst |  21 +-
 doc/guides/howto/pvp_reference_benchmark.rst  |  27 +-
 doc/guides/howto/vfd.rst                      |   4 +-
 .../virtio_user_for_container_networking.rst  |   2 +-
 doc/guides/linux_gsg/build_dpdk.rst           |  16 +-
 doc/guides/linux_gsg/build_sample_apps.rst    |  18 +-
 doc/guides/linux_gsg/enable_func.rst          |  13 +-
 doc/guides/linux_gsg/linux_drivers.rst        |  18 +-
 doc/guides/linux_gsg/sys_reqs.rst             |   6 +-
 doc/guides/mempool/octeontx.rst               |  28 +-
 doc/guides/mempool/octeontx2.rst              |  10 +-
 doc/guides/nics/ark.rst                       |  26 -
 doc/guides/nics/atlantic.rst                  |   4 -
 doc/guides/nics/axgbe.rst                     |  15 -
 doc/guides/nics/bnx2x.rst                     |  27 -
 doc/guides/nics/bnxt.rst                      |   5 +-
 doc/guides/nics/build_and_test.rst            |   8 +-
 doc/guides/nics/cxgbe.rst                     |  36 +-
 doc/guides/nics/dpaa.rst                      |  27 +-
 doc/guides/nics/dpaa2.rst                     |  26 +-
 doc/guides/nics/ena.rst                       |  16 -
 doc/guides/nics/enetc.rst                     |   2 -
 doc/guides/nics/enic.rst                      |   9 -
 doc/guides/nics/fail_safe.rst                 |  20 +-
 doc/guides/nics/features.rst                  |   9 -
 doc/guides/nics/fm10k.rst                     |   4 -
 doc/guides/nics/hinic.rst                     |   9 -
 doc/guides/nics/hns3.rst                      |  10 -
 doc/guides/nics/i40e.rst                      |  44 +-
 doc/guides/nics/ice.rst                       |  25 +-
 doc/guides/nics/igc.rst                       |  18 +-
 doc/guides/nics/intel_vf.rst                  |  13 +-
 doc/guides/nics/ionic.rst                     |   8 -
 doc/guides/nics/ipn3ke.rst                    |  12 +-
 doc/guides/nics/kni.rst                       |   4 +-
 doc/guides/nics/liquidio.rst                  |  27 -
 doc/guides/nics/memif.rst                     |  10 +-
 doc/guides/nics/mlx4.rst                      |  55 +-
 doc/guides/nics/mlx5.rst                      |  62 +-
 doc/guides/nics/mvneta.rst                    |  36 +-
 doc/guides/nics/mvpp2.rst                     |  43 +-
 doc/guides/nics/nfb.rst                       |  19 +-
 doc/guides/nics/nfp.rst                       |   4 -
 doc/guides/nics/null.rst                      |   6 +-
 doc/guides/nics/octeontx.rst                  |  19 +-
 doc/guides/nics/octeontx2.rst                 |  13 +-
 doc/guides/nics/pcap_ring.rst                 |  24 +-
 doc/guides/nics/qede.rst                      |  17 +-
 doc/guides/nics/sfc_efx.rst                   |  15 -
 doc/guides/nics/softnic.rst                   |  13 +-
 doc/guides/nics/szedata2.rst                  |  18 +-
 doc/guides/nics/thunderx.rst                  |  25 +-
 doc/guides/nics/vdev_netvsc.rst               |   6 -
 doc/guides/nics/vhost.rst                     |   2 +-
 doc/guides/nics/virtio.rst                    |   4 +-
 doc/guides/platform/bluefield.rst             |  22 -
 doc/guides/platform/octeontx.rst              |  33 +-
 doc/guides/platform/octeontx2.rst             |  32 -
 .../prog_guide/env_abstraction_layer.rst      |  17 +-
 doc/guides/prog_guide/graph_lib.rst           |   6 +-
 .../prog_guide/ip_fragment_reassembly_lib.rst |   5 -
 .../prog_guide/kernel_nic_interface.rst       |  14 +-
 .../link_bonding_poll_mode_drv_lib.rst        |  15 +-
 doc/guides/prog_guide/lto.rst                 |  12 +-
 doc/guides/prog_guide/mbuf_lib.rst            |   4 +-
 doc/guides/prog_guide/mempool_lib.rst         |   7 +-
 doc/guides/prog_guide/profile_app.rst         |  17 +-
 doc/guides/prog_guide/qos_framework.rst       |  10 +-
 doc/guides/prog_guide/rcu_lib.rst             |   7 +-
 doc/guides/prog_guide/trace_lib.rst           |   3 +-
 .../prog_guide/writing_efficient_code.rst     |   3 +-
 doc/guides/rawdevs/dpaa2_cmdif.rst            |  21 -
 doc/guides/rawdevs/dpaa2_qdma.rst             |  21 -
 doc/guides/rawdevs/ifpga.rst                  |  10 -
 doc/guides/rawdevs/ioat.rst                   |   8 +-
 doc/guides/rawdevs/ntb.rst                    |   6 -
 doc/guides/rawdevs/octeontx2_dma.rst          |  12 -
 doc/guides/rawdevs/octeontx2_ep.rst           |   8 -
 doc/guides/rel_notes/release_20_11.rst        |   3 +
 doc/guides/sample_app_ug/bbdev_app.rst        |  34 +-
 doc/guides/sample_app_ug/cmd_line.rst         |   2 +-
 doc/guides/sample_app_ug/compiling.rst        |  83 +--
 doc/guides/sample_app_ug/dist_app.rst         |   4 +-
 doc/guides/sample_app_ug/ethtool.rst          |   2 +-
 .../sample_app_ug/eventdev_pipeline.rst       |   3 +-
 doc/guides/sample_app_ug/fips_validation.rst  |  10 +-
 doc/guides/sample_app_ug/flow_classify.rst    |   4 +-
 doc/guides/sample_app_ug/flow_filtering.rst   |  25 +-
 doc/guides/sample_app_ug/hello_world.rst      |   2 +-
 doc/guides/sample_app_ug/ioat.rst             |   6 +-
 doc/guides/sample_app_ug/ip_frag.rst          |   6 +-
 doc/guides/sample_app_ug/ip_pipeline.rst      |   4 +-
 doc/guides/sample_app_ug/ip_reassembly.rst    |   9 +-
 doc/guides/sample_app_ug/ipsec_secgw.rst      |  14 +-
 doc/guides/sample_app_ug/ipv4_multicast.rst   |   4 +-
 doc/guides/sample_app_ug/keep_alive.rst       |   4 +-
 .../sample_app_ug/kernel_nic_interface.rst    |  14 +-
 doc/guides/sample_app_ug/l2_forward_cat.rst   |   4 +-
 .../sample_app_ug/l2_forward_crypto.rst       |   4 +-
 doc/guides/sample_app_ug/l2_forward_event.rst |  10 +-
 .../sample_app_ug/l2_forward_job_stats.rst    |   4 +-
 .../sample_app_ug/l2_forward_real_virtual.rst |   6 +-
 doc/guides/sample_app_ug/l3_forward.rst       |  10 +-
 .../sample_app_ug/l3_forward_access_ctrl.rst  |   6 +-
 doc/guides/sample_app_ug/l3_forward_graph.rst |   4 +-
 .../sample_app_ug/l3_forward_power_man.rst    |  14 +-
 doc/guides/sample_app_ug/link_status_intr.rst |   4 +-
 doc/guides/sample_app_ug/multi_process.rst    |  20 +-
 doc/guides/sample_app_ug/ntb.rst              |   2 +-
 doc/guides/sample_app_ug/packet_ordering.rst  |   3 +-
 .../sample_app_ug/performance_thread.rst      |  44 +-
 doc/guides/sample_app_ug/ptpclient.rst        |   9 +-
 doc/guides/sample_app_ug/qos_metering.rst     |   2 +-
 doc/guides/sample_app_ug/qos_scheduler.rst    |  10 +-
 doc/guides/sample_app_ug/rxtx_callbacks.rst   |   9 +-
 doc/guides/sample_app_ug/server_node_efd.rst  |   2 +-
 doc/guides/sample_app_ug/service_cores.rst    |  23 +-
 doc/guides/sample_app_ug/skeleton.rst         |   2 +-
 doc/guides/sample_app_ug/tep_termination.rst  |  43 +-
 doc/guides/sample_app_ug/test_pipeline.rst    |   4 +-
 doc/guides/sample_app_ug/timer.rst            |   2 +-
 doc/guides/sample_app_ug/vdpa.rst             |   4 +-
 doc/guides/sample_app_ug/vhost.rst            |  11 +-
 doc/guides/sample_app_ug/vhost_blk.rst        |   2 +-
 doc/guides/sample_app_ug/vhost_crypto.rst     |   2 +-
 .../sample_app_ug/vm_power_management.rst     |  34 +-
 .../sample_app_ug/vmdq_dcb_forwarding.rst     |   8 +-
 doc/guides/sample_app_ug/vmdq_forwarding.rst  |   8 +-
 doc/guides/testpmd_app_ug/run_app.rst         |   6 +-
 doc/guides/testpmd_app_ug/testpmd_funcs.rst   |   9 +-
 doc/guides/tools/comp_perf.rst                |  10 +-
 doc/guides/tools/cryptoperf.rst               |  20 +-
 doc/guides/tools/pdump.rst                    |  15 +-
 doc/guides/tools/proc_info.rst                |   2 +-
 doc/guides/tools/testbbdev.rst                |  38 +-
 doc/guides/tools/testeventdev.rst             |  21 +-
 doc/guides/vdpadevs/ifc.rst                   |  13 -
 doc/guides/vdpadevs/mlx5.rst                  |  40 +-
 178 files changed, 812 insertions(+), 2374 deletions(-)
Signature · 1 line
2.17.1
#215 lore raw

PATCH v5 1/20 devtools: remove legacy flags from includes check

Make is no longer supported, the test script for make builds is no longer required. Uses of make in other tool scripts are replaced.

---
 devtools/check-includes.sh | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)
devtools/check-includes.sh +5 -6
index 749b9b26d2..940cf0eb2a 100755
@@ -17,8 +17,7 @@
 #
 # SUMMARY=1 is the same as -s.
 #
-# CC, CPPFLAGS, CFLAGS, EXTRA_CPPFLAGS, EXTRA_CFLAGS, CXX, CXXFLAGS and
-# EXTRA_CXXFLAGS are taken into account.
+# CC, CPPFLAGS, CFLAGS, CXX, CXXFLAGS are taken into account.
 #
 # PEDANTIC_CFLAGS, PEDANTIC_CXXFLAGS and PEDANTIC_CPPFLAGS provide strict
 # C/C++ compilation flags.
@@ -130,16 +129,16 @@ trap 'rm -f "$temp_cc" "$temp_cxx"' EXIT
 compile_cc ()
 {
 	${CC} -I"$include_dir" \
-		${PEDANTIC_CPPFLAGS} ${CPPFLAGS} ${EXTRA_CPPFLAGS} \
-		${PEDANTIC_CFLAGS} ${CFLAGS} ${EXTRA_CFLAGS} \
+		${PEDANTIC_CPPFLAGS} ${CPPFLAGS} \
+		${PEDANTIC_CFLAGS} ${CFLAGS} \
 		-c -o /dev/null "${temp_cc}"
 }
 
 compile_cxx ()
 {
 	${CXX} -I"$include_dir" \
-		${PEDANTIC_CPPFLAGS} ${CPPFLAGS} ${EXTRA_CPPFLAGS} \
-		${PEDANTIC_CXXFLAGS} ${CXXFLAGS} ${EXTRA_CXXFLAGS} \
+		${PEDANTIC_CPPFLAGS} ${CPPFLAGS} \
+		${PEDANTIC_CXXFLAGS} ${CXXFLAGS} \
 		-c -o /dev/null "${temp_cxx}"
 }
 
Signature · 1 line
2.17.1
#216 lore raw

PATCH v5 2/20 app: remove references to make-based config

In reply to Ciara Power

Make is no longer supported, RTE_SDK, RTE_TARGET and CONFIG options are no longer in use.

---
v5: updated binary name to dpdk-test-bbdev

---
 app/test-bbdev/test-bbdev.py   | 13 ++---
 app/test/test_cryptodev.c      | 89 +++++++++-------------------------
 app/test/test_cryptodev_asym.c | 18 ++-----
 3 files changed, 29 insertions(+), 91 deletions(-)
app/test-bbdev/test-bbdev.py +3 -10
index 5ae2dc6c49..2d1f1dfc55 100755
@@ -20,22 +20,15 @@ def kill(process):
     print("WARNING: Python 2 is deprecated for use in DPDK, and will not work in future releases.", file=sys.stderr)
     print("Please use Python 3 instead", file=sys.stderr)
 
-if "RTE_SDK" in os.environ:
-    dpdk_path = os.environ["RTE_SDK"]
-else:
-    dpdk_path = "../.."
-
-if "RTE_TARGET" in os.environ:
-    dpdk_target = os.environ["RTE_TARGET"]
-else:
-    dpdk_target = "x86_64-native-linux-gcc"
+dpdk_path = "../.."
+dpdk_target = "build"
 
 parser = argparse.ArgumentParser(
                     description='BBdev Unit Test Application',
                     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
 parser.add_argument("-p", "--testapp-path",
                     help="specifies path to the bbdev test app",
-                    default=dpdk_path + "/" + dpdk_target + "/app/testbbdev")
+                    default=dpdk_path + "/" + dpdk_target + "/app/dpdk-test-bbdev")
 parser.add_argument("-e", "--eal-params",
                     help="EAL arguments which are passed to the test app",
                     default="--vdev=baseband_null0")
app/test/test_cryptodev.c +22 -67

220 lines not on this page · raw message

app/test/test_cryptodev_asym.c +4 -14
index dc62ed7bf3..85cd076059 100644
@@ -2336,9 +2336,7 @@ test_cryptodev_openssl_asym(void)
 			RTE_STR(CRYPTODEV_NAME_OPENSSL_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_OPENSSL is enabled "
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
 
@@ -2352,9 +2350,7 @@ test_cryptodev_qat_asym(void)
 			RTE_STR(CRYPTODEV_NAME_QAT_ASYM_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "QAT PMD must be loaded. Check if "
-				    "CONFIG_RTE_LIBRTE_PMD_QAT_ASYM is enabled "
-				    "in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "QAT PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
 
@@ -2367,10 +2363,7 @@ test_cryptodev_octeontx_asym(void)
 	gbl_driver_id = rte_cryptodev_driver_id_get(
 			RTE_STR(CRYPTODEV_NAME_OCTEONTX_SYM_PMD));
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO is "
-				"enabled in config file to run this "
-				"testsuite.\n");
+		RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
 	return unit_test_suite_runner(&cryptodev_octeontx_asym_testsuite);
@@ -2382,10 +2375,7 @@ test_cryptodev_octeontx2_asym(void)
 	gbl_driver_id = rte_cryptodev_driver_id_get(
 			RTE_STR(CRYPTODEV_NAME_OCTEONTX2_PMD));
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "OCTEONTX2 PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_CRYPTO is "
-				"enabled in config file to run this "
-				"testsuite.\n");
+		RTE_LOG(ERR, USER1, "OCTEONTX2 PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
 
Signature · 1 line
2.17.1
Acked-by on v5 2/20
#217 lore raw

Re: [dpdk-dev] [PATCH v5 02/20] app: remove references to make-based config

Thanks for the update
Nic

Quoted 404 lines

-----Original Message-----
From: Power, Ciara <[email protected]>
Sent: Monday, September 21, 2020 6:59 AM
To: [email protected]
Cc: Power, Ciara <[email protected]>; Chautru, Nicolas <[email protected]>; Doherty, Declan <[email protected]>
Subject: [PATCH v5 02/20] app: remove references to make-based config

Make is no longer supported, RTE_SDK, RTE_TARGET and CONFIG options are no longer in use.

---
v5: updated binary name to dpdk-test-bbdev

---
 app/test-bbdev/test-bbdev.py   | 13 ++---
 app/test/test_cryptodev.c      | 89 +++++++++-------------------------
 app/test/test_cryptodev_asym.c | 18 ++-----
 3 files changed, 29 insertions(+), 91 deletions(-)
app/test-bbdev/test-bbdev.py index renamed from app/test-bbdev/test-bbdev.py +0 -0

5ae2dc6c49..2d1f1dfc55 100755

app/test-bbdev/test-bbdev.py +4 -10
@@ -20,22 +20,15 @@ def kill(process):
     print("WARNING: Python 2 is deprecated for use in DPDK, and will not work
 in future releases.", file=sys.stderr)
     print("Please use Python 3 instead", file=sys.stderr)
 
-if "RTE_SDK" in os.environ:
-    dpdk_path = os.environ["RTE_SDK"]
-else:
-    dpdk_path = "../.."
-
-if "RTE_TARGET" in os.environ:
-    dpdk_target = os.environ["RTE_TARGET"]
-else:
-    dpdk_target = "x86_64-native-linux-gcc"
+dpdk_path = "../.."
+dpdk_target = "build"
 
 parser = argparse.ArgumentParser(
                     description='BBdev Unit Test Application',
                     formatter_class=argparse.ArgumentDefaultsHelpFormatter)
 parser.add_argument("-p", "--testapp-path",
                     help="specifies path to the bbdev test app",
-                    default=dpdk_path + "/" + dpdk_target + "/app/testbbdev")
+                    default=dpdk_path + "/" + dpdk_target +
+ "/app/dpdk-test-bbdev")
 parser.add_argument("-e", "--eal-params",
                     help="EAL arguments which are passed to the test app",
                     default="--vdev=baseband_null0") diff --git

a/app/test/test_cryptodev.c b/app/test/test_cryptodev.c index 70bf6fe2c1..153d001194 100644

app/test/test_cryptodev.c +0 -1
@@ -12688,9 +12688,7 @@ test_cryptodev_qat(void /*argv __rte_unused,
 int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_QAT_SYM_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "QAT PMD must be loaded. Check that

both "

app/test/test_cryptodev.c +0 -1
-		"CONFIG_RTE_LIBRTE_PMD_QAT and

CONFIG_RTE_LIBRTE_PMD_QAT_SYM "

app/test/test_cryptodev.c +1 -3
-		"are enabled in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "QAT PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12704,9 +12702,7 @@ test_cryptodev_virtio(void /*argv __rte_unused,
 int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_VIRTIO_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "VIRTIO PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_VIRTIO_CRYPTO

is enabled "

app/test/test_cryptodev.c +1 -2
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "VIRTIO PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
@@ -12720,9 +12716,7 @@ test_cryptodev_aesni_mb(void /*argv
 __rte_unused, int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_AESNI_MB_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded. Check

if "

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_AESNI_MB is

enabled "

app/test/test_cryptodev.c +1 -2
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12739,9 +12733,7 @@ test_cryptodev_cpu_aesni_mb(void)
 			RTE_STR(CRYPTODEV_NAME_AESNI_MB_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded. Check

if "

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_AESNI_MB is

enabled "

app/test/test_cryptodev.c +1 -2
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12759,9 +12751,7 @@ test_cryptodev_openssl(void)
 			RTE_STR(CRYPTODEV_NAME_OPENSSL_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded. Check if

"

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_OPENSSL is

enabled "

app/test/test_cryptodev.c +1 -2
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12775,9 +12765,7 @@ test_cryptodev_aesni_gcm(void)
 			RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "AESNI GCM PMD must be loaded.

Check if "

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_AESNI_GCM is

enabled "

app/test/test_cryptodev.c +1 -2
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "AESNI GCM PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12794,9 +12782,7 @@ test_cryptodev_cpu_aesni_gcm(void)
 			RTE_STR(CRYPTODEV_NAME_AESNI_GCM_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "AESNI GCM PMD must be loaded.

Check if "

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_AESNI_GCM is

enabled "

app/test/test_cryptodev.c +2 -5
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "AESNI GCM PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12814,9 +12800,7 @@ test_cryptodev_null(void)
 			RTE_STR(CRYPTODEV_NAME_NULL_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "NULL PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_NULL is enabled "
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "NULL PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
 
@@ -12830,9 +12814,7 @@ test_cryptodev_sw_snow3g(void /*argv
 __rte_unused, int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_SNOW3G_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "SNOW3G PMD must be loaded. Check

if "

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_SNOW3G is

enabled "

app/test/test_cryptodev.c +1 -3
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "SNOW3G PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12846,9 +12828,7 @@ test_cryptodev_sw_kasumi(void /*argv
 __rte_unused, int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_KASUMI_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "ZUC PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_KASUMI is

enabled "

app/test/test_cryptodev.c +2 -6
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "ZUC PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12862,9 +12842,7 @@ test_cryptodev_sw_zuc(void /*argv
 __rte_unused, int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_ZUC_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "ZUC PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_ZUC is enabled "
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "ZUC PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12878,9 +12856,7 @@ test_cryptodev_armv8(void)
 			RTE_STR(CRYPTODEV_NAME_ARMV8_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "ARMV8 PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_ARMV8 is

enabled "

app/test/test_cryptodev.c +1 -2
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "ARMV8 PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12894,9 +12870,7 @@ test_cryptodev_mrvl(void)
 			RTE_STR(CRYPTODEV_NAME_MVSAM_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "MVSAM PMD must be loaded. Check if

"

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_MVSAM_CRYPTO

is enabled "

app/test/test_cryptodev.c +1 -2
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "MVSAM PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12912,16 +12886,13 @@ test_cryptodev_scheduler(void /*argv
 __rte_unused, int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_SCHEDULER_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "SCHEDULER PMD must be loaded.

Check if "

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_SCHEDULER is

enabled "

app/test/test_cryptodev.c +1 -1
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "SCHEDULER PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
 
 	if (rte_cryptodev_driver_id_get(
	RTE_STR(CRYPTODEV_NAME_AESNI_MB_PMD)) == -1) {
app/test/test_cryptodev.c +0 -1
-		RTE_LOG(ERR, USER1, "CONFIG_RTE_LIBRTE_PMD_AESNI_MB

must be"

app/test/test_cryptodev.c +1 -2
-			" enabled in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "AESNI MB PMD must be loaded.\n");
 		return TEST_SKIPPED;
 }
 	return unit_test_suite_runner(&cryptodev_scheduler_testsuite);
@@ -12938,9 +12909,7 @@ test_cryptodev_dpaa2_sec(void /*argv
 __rte_unused, int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_DPAA2_SEC_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "DPAA2 SEC PMD must be loaded. Check

if "

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_DPAA2_SEC is

enabled "

app/test/test_cryptodev.c +1 -2
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "DPAA2 SEC PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12954,9 +12923,7 @@ test_cryptodev_dpaa_sec(void /*argv
 __rte_unused, int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_DPAA_SEC_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "DPAA SEC PMD must be loaded. Check

if "

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_DPAA_SEC is

enabled "

app/test/test_cryptodev.c +2 -5
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "DPAA SEC PMD must be loaded.\n");
 		return TEST_SKIPPED;
 	}
@@ -12970,9 +12937,7 @@ test_cryptodev_ccp(void)
 			RTE_STR(CRYPTODEV_NAME_CCP_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "CCP PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_CCP is enabled "
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "CCP PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
 
@@ -12985,10 +12950,7 @@ test_cryptodev_octeontx(void)
 	gbl_driver_id =	rte_cryptodev_driver_id_get(
 
 	RTE_STR(CRYPTODEV_NAME_OCTEONTX_SYM_PMD));
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded. Check

if "
-
"CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO is "

app/test/test_cryptodev.c +1 -3
-				"enabled in config file to run this "
-				"testsuite.\n");
+		RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
 	return unit_test_suite_runner(&cryptodev_testsuite);
@@ -13000,10 +12962,7 @@ test_cryptodev_octeontx2(void)
 	gbl_driver_id =	rte_cryptodev_driver_id_get(
 			RTE_STR(CRYPTODEV_NAME_OCTEONTX2_PMD));
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "OCTEON TX2 PMD must be loaded.

Check if "
-
"CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_CRYPTO is "

app/test/test_cryptodev.c +1 -3
-				"enabled in config file to run this "
-				"testsuite.\n");
+		RTE_LOG(ERR, USER1, "OCTEON TX2 PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
 	return unit_test_suite_runner(&cryptodev_testsuite);
@@ -13016,9 +12975,7 @@ test_cryptodev_caam_jr(void /*argv
 __rte_unused, int argc __rte_unused*/)
 			RTE_STR(CRYPTODEV_NAME_CAAM_JR_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "CAAM_JR PMD must be loaded. Check

if "

app/test/test_cryptodev.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_CAAM_JR is

enabled "

app/test/test_cryptodev.c +1 -3
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "CAAM_JR PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
@@ -13032,9 +12989,7 @@ test_cryptodev_nitrox(void)
 			RTE_STR(CRYPTODEV_NAME_NITROX_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "NITROX PMD must be loaded. Check if "
-				"CONFIG_RTE_LIBRTE_PMD_NITROX is

enabled "

app/test/test_cryptodev.c +1 -1
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "NITROX PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
app/test/test_cryptodev_asym.c +0 -1
index dc62ed7bf3..85cd076059 100644
@@ -2336,9 +2336,7 @@ test_cryptodev_openssl_asym(void)
 			RTE_STR(CRYPTODEV_NAME_OPENSSL_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded. Check if

"

app/test/test_cryptodev_asym.c +0 -1
-				"CONFIG_RTE_LIBRTE_PMD_OPENSSL is

enabled "

app/test/test_cryptodev_asym.c +1 -3
-				"in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "OPENSSL PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
@@ -2352,9 +2350,7 @@ test_cryptodev_qat_asym(void)
 			RTE_STR(CRYPTODEV_NAME_QAT_ASYM_PMD));
 
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "QAT PMD must be loaded. Check if "
-				    "CONFIG_RTE_LIBRTE_PMD_QAT_ASYM is

enabled "

app/test/test_cryptodev_asym.c +1 -2
-				    "in config file to run this testsuite.\n");
+		RTE_LOG(ERR, USER1, "QAT PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
@@ -2367,10 +2363,7 @@ test_cryptodev_octeontx_asym(void)
 	gbl_driver_id = rte_cryptodev_driver_id_get(
 
 	RTE_STR(CRYPTODEV_NAME_OCTEONTX_SYM_PMD));
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded. Check

if "
-
"CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO is "

app/test/test_cryptodev_asym.c +1 -3
-				"enabled in config file to run this "
-				"testsuite.\n");
+		RTE_LOG(ERR, USER1, "OCTEONTX PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
 	return unit_test_suite_runner(&cryptodev_octeontx_asym_testsuite);
@@ -2382,10 +2375,7 @@ test_cryptodev_octeontx2_asym(void)
 	gbl_driver_id = rte_cryptodev_driver_id_get(
 			RTE_STR(CRYPTODEV_NAME_OCTEONTX2_PMD));
 	if (gbl_driver_id == -1) {
-		RTE_LOG(ERR, USER1, "OCTEONTX2 PMD must be loaded.

Check if "
-
"CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_CRYPTO is "

app/test/test_cryptodev_asym.c +1 -3
-				"enabled in config file to run this "
-				"testsuite.\n");
+		RTE_LOG(ERR, USER1, "OCTEONTX2 PMD must be loaded.\n");
 		return TEST_FAILED;
 	}
 
--

2.17.1

#218 lore raw

PATCH v5 3/20 doc: remove references to make from Linux guide

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/linux_gsg/build_dpdk.rst        | 16 +++++++++++-----
 doc/guides/linux_gsg/build_sample_apps.rst | 18 +++---------------
 doc/guides/linux_gsg/enable_func.rst       | 13 +++++--------
 doc/guides/linux_gsg/linux_drivers.rst     | 18 +++++++++++-------
 doc/guides/linux_gsg/sys_reqs.rst          |  6 +-----
 5 files changed, 31 insertions(+), 40 deletions(-)
doc/guides/linux_gsg/build_dpdk.rst +11 -5
index a895e1b0f4..85d04520bf 100644
@@ -76,6 +76,8 @@ and the last step causing the dynamic loader `ld.so` to update its cache to take
    distributions, `/usr/local/lib` and `/usr/local/lib64` should be added
    to a file in `/etc/ld.so.conf.d/` before running `ldconfig`.
 
+.. _adjusting_build_options:
+
 
 Adjusting Build Options
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -112,6 +114,9 @@ dependencies are met on the current system are built.
 When `-Dexamples=all` is set as a meson option, meson will check each example application to see if it can be built,
 and add all which can be built to the list of tasks in the ninja build configuration file.
 
+.. _building_app_using_installed_dpdk:
+
+
 Building Applications Using Installed DPDK
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -135,11 +140,12 @@ and the sources for that build are stored in ``$(SRCS-y)``.
 
 .. note::
 
-   Unlike with the older make build system, the meson system is not
-   designed to be used directly from a build directory. Instead it is
-   recommended that it be installed either system-wide or to a known
-   location in the user's home directory. The install location can be set
-   using the `--prefix` meson option (default: `/usr/local`).
+   Unlike with the make build system present used in older DPDK releases,
+   the meson system is not designed to be used directly from a build
+   directory. Instead it is recommended that it be installed either
+   system-wide or to a known location in the user's home directory.
+   The install location can be set using the `--prefix` meson option
+   (default: `/usr/local`).
 
 an equivalent build recipe for a simple DPDK application using meson as a
 build system is shown below:
doc/guides/linux_gsg/build_sample_apps.rst +3 -15
index 2882883f95..f4bf0e71e5 100644
@@ -1,7 +1,7 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
-Compiling and Running Sample Applications
+Running Sample Applications
 =========================================
 
 The chapter describes how to compile and run applications in an DPDK environment.
@@ -119,7 +119,7 @@ Copy the DPDK application binary to your target, then run the application as fol
 (assuming the platform has four memory channels per processor socket,
 and that cores 0-3 are present and are to be used for running the application)::
 
-    ./helloworld -l 0-3 -n 4
+    ./dpdk-helloworld -l 0-3 -n 4
 
 .. note::
 
@@ -183,19 +183,7 @@ If the DPDK cannot allocate enough memory on each socket, the EAL initialization
 Additional Sample Applications
 ------------------------------
 
-Additional sample applications are included in the ${RTE_SDK}/examples directory.
+Additional sample applications are included in the DPDK examples directory.
 These sample applications may be built and run in a manner similar to that described in earlier sections in this manual.
 In addition, see the *DPDK Sample Applications User Guide* for a description of the application,
 specific instructions on compilation and execution and some explanation of the code.
-
-Additional Test Applications
-----------------------------
-
-In addition, there are two other applications that are built when the libraries are created.
-The source files for these are in the DPDK/app directory and are called test and testpmd.
-Once the libraries are created, they can be found in the build/app directory.
-
-*   The test application provides a variety of specific tests for the various functions in the DPDK.
-
-*   The testpmd application provides a number of different packet throughput tests and
-    examples of features such as how to use the Flow Director found in the Intel® 82599 10 Gigabit Ethernet Controller.
doc/guides/linux_gsg/enable_func.rst +5 -8
index b2bda80bb7..08f55d8543 100644
@@ -41,7 +41,9 @@ Enabling HPET in the DPDK
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 By default, HPET support is disabled in the DPDK build configuration files.
-To use HPET, the ``CONFIG_RTE_LIBEAL_USE_HPET`` setting should be changed to ``y``, which will enable the HPET settings at compile time.
+To use HPET, use the following meson build option which will enable the HPET settings at compile time::
+
+   meson configure -Duse_hpet=true
 
 For an application to use the ``rte_get_hpet_cycles()`` and ``rte_get_hpet_hz()`` API calls,
 and optionally to make the HPET the default time source for the rte_timer library,
@@ -128,13 +130,8 @@ Loading the DPDK KNI Kernel Module
 ----------------------------------
 
 To run the DPDK Kernel NIC Interface (KNI) sample application, an extra kernel module (the kni module) must be loaded into the running kernel.
-The module is found in the kmod sub-directory of the DPDK target directory.
-Similar to the loading of the ``igb_uio`` module, this module should be loaded using the insmod command as shown below
-(assuming that the current directory is the DPDK target directory):
-
-.. code-block:: console
-
-   insmod kmod/rte_kni.ko
+The module is found in the kernel/linux sub-directory of the DPDK build directory.
+This can be enabled in the same way as the ``igb_uio`` module, please see :ref:`load_uio` for details.
 
 .. note::
 
doc/guides/linux_gsg/linux_drivers.rst +11 -7
index 185074013a..349be1c906 100644
@@ -12,6 +12,9 @@ Different PMDs may require different kernel drivers in order to work properly.
 Depends on the PMD being used, a corresponding kernel driver should be load
 and bind to the network ports.
 
+.. _load_uio:
+
+
 UIO
 ---
 
@@ -28,19 +31,20 @@ can provide the uio capability. This module can be loaded using the command:
     ``uio_pci_generic`` module doesn't support the creation of virtual functions.
 
 As an alternative to the ``uio_pci_generic``, the DPDK also includes the igb_uio
-module which can be found in the kmod subdirectory referred to above. It can
+module which can be found in the kernel/linux subdirectory referred to above. It can
 be loaded as shown below:
 
 .. code-block:: console
 
     sudo modprobe uio
-    sudo insmod kmod/igb_uio.ko
+    sudo insmod <build_dir>/kernel/linux/igb_uio/igb_uio.ko
 
 .. note::
 
-   ``igb_uio`` module is disabled by default starting from ``DPDK v20.02``.
-   To build it, the config option ``CONFIG_RTE_EAL_IGB_UIO`` should be enabled.
-   It is planned to move ``igb_uio`` module to a different git repository.
+   Building DPDK Linux kernel modules is disabled by default starting from DPDK v20.02.
+   To enable them again, the config option "enable_kmods" needs to be set in the meson
+   build configuration. See :ref:`adjusting_build_options` for details on how to set/clear
+   build options. It is planned to move ``igb_uio`` module to a different git repository.
 
 .. note::
 
@@ -104,11 +108,11 @@ parameter ``--vfio-vf-token``.
     3. echo 2 > /sys/bus/pci/devices/0000:86:00.0/sriov_numvfs
 
     4. Start the PF:
-        ./x86_64-native-linux-gcc/app/testpmd -l 22-25 -n 4 -w 86:00.0 \
+        ./<build_dir>/app/dpdk-testpmd -l 22-25 -n 4 -w 86:00.0 \
          --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=pf -- -i
 
     5. Start the VF:
-        ./x86_64-native-linux-gcc/app/testpmd -l 26-29 -n 4 -w 86:02.0 \
+        ./<build_dir>/app/dpdk-testpmd -l 26-29 -n 4 -w 86:02.0 \
          --vfio-vf-token=14d63f20-8445-11ea-8900-1f9ce7d5650d --file-prefix=vf0 -- -i
 
 Also, to use VFIO, both kernel and BIOS must support and be configured to use IO virtualization (such as Intel® VT-d).
doc/guides/linux_gsg/sys_reqs.rst +1 -5
index 6b9f573fce..625fb58066 100644
@@ -43,11 +43,7 @@ Compilation of the DPDK
 
     * For Ubuntu/Debian systems these can be installed using ``apt install build-essential``
 
-*   Python, recommended version 3.5+.
-
-    * Python v3.5+ is needed to build DPDK using meson and ninja
-
-    * Python 2.7+ or 3.2+, to use various helper scripts included in the DPDK package.
+*   Python, v3.5 or later.
 
 *   Meson (version 0.47.1+) and ninja
 
Signature · 1 line
2.17.1
#219 lore raw

Re: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide

Hi,

Below are some comments. If you agree, I will do the changes myself while pushing to the main branch.

21/09/2020 15:59, Ciara Power:

Quoted 18 lines

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/linux_gsg/build_dpdk.rst        | 16 +++++++++++-----
 doc/guides/linux_gsg/build_sample_apps.rst | 18 +++---------------
 doc/guides/linux_gsg/enable_func.rst       | 13 +++++--------
 doc/guides/linux_gsg/linux_drivers.rst     | 18 +++++++++++-------
 doc/guides/linux_gsg/sys_reqs.rst          |  6 +-----
 5 files changed, 31 insertions(+), 40 deletions(-)
doc/guides/linux_gsg/build_dpdk.rst +0 -0
index a895e1b0f4..85d04520bf 100644

doc/guides/linux_gsg/build_dpdk.rst and the last step causing the dynamic loader `ld.so` to update its cache to take · line 80

Quoted 5 lines
doc/guides/linux_gsg/build_dpdk.rst +2 -0
@@ -76,6 +76,8 @@ and the last step causing the dynamic loader `ld.so` to update its cache to take
    distributions, `/usr/local/lib` and `/usr/local/lib64` should be added
    to a file in `/etc/ld.so.conf.d/` before running `ldconfig`.
 
+.. _adjusting_build_options:
+

extra blank line

doc/guides/linux_gsg/build_dpdk.rst dependencies are met on the current system are built. · line 119

Quoted 10 lines
doc/guides/linux_gsg/build_dpdk.rst +3 -0
 Adjusting Build Options
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -112,6 +114,9 @@ dependencies are met on the current system are built.
 When `-Dexamples=all` is set as a meson option, meson will check each example application to see if it can be built,
 and add all which can be built to the list of tasks in the ninja build configuration file.
 
+.. _building_app_using_installed_dpdk:
+
+

extra blank line

Quoted 8 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -1
 Building Applications Using Installed DPDK
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -135,11 +140,12 @@ and the sources for that build are stored in ``$(SRCS-y)``.
 
 .. note::
 
-   Unlike with the older make build system, the meson system is not

doc/guides/linux_gsg/build_dpdk.rst and the sources for that build are stored in ``$(SRCS-y)``. · line 148

Quoted 10 lines
doc/guides/linux_gsg/build_dpdk.rst +6 -4
-   designed to be used directly from a build directory. Instead it is
-   recommended that it be installed either system-wide or to a known
-   location in the user's home directory. The install location can be set
-   using the `--prefix` meson option (default: `/usr/local`).
+   Unlike with the make build system present used in older DPDK releases,
+   the meson system is not designed to be used directly from a build
+   directory. Instead it is recommended that it be installed either
+   system-wide or to a known location in the user's home directory.
+   The install location can be set using the `--prefix` meson option
+   (default: `/usr/local`).

I prefer the first version.
The words "system present used" look weird.
Anyway, if any reword is needed, better to change only the impacted line and keep the rest of the line wrapping untouched.

Quoted 8 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
 an equivalent build recipe for a simple DPDK application using meson as a
 build system is shown below:
doc/guides/linux_gsg/build_sample_apps.rst +0 -0
index 2882883f95..f4bf0e71e5 100644

doc/guides/linux_gsg/build_sample_apps.rst line 5

Quoted 6 lines
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -1,7 +1,7 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
-Compiling and Running Sample Applications
+Running Sample Applications
 =========================================

Underlining must be adjusted

Quoted 22 lines
doc/guides/linux_gsg/build_sample_apps.rst +2 -4
 The chapter describes how to compile and run applications in an DPDK environment.
@@ -119,7 +119,7 @@ Copy the DPDK application binary to your target, then run the application as fol
 (assuming the platform has four memory channels per processor socket,
 and that cores 0-3 are present and are to be used for running the application)::
 
-    ./helloworld -l 0-3 -n 4
+    ./dpdk-helloworld -l 0-3 -n 4
 
 .. note::
 
@@ -183,19 +183,7 @@ If the DPDK cannot allocate enough memory on each socket, the EAL initialization
 Additional Sample Applications
 ------------------------------
 
-Additional sample applications are included in the ${RTE_SDK}/examples directory.
+Additional sample applications are included in the DPDK examples directory.
 These sample applications may be built and run in a manner similar to that described in earlier sections in this manual.
 In addition, see the *DPDK Sample Applications User Guide* for a description of the application,
 specific instructions on compilation and execution and some explanation of the code.
-
-Additional Test Applications

doc/guides/linux_gsg/build_sample_apps.rst If the DPDK cannot allocate enough memory on each socket, the EAL initialization · line 201

Quoted 10 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -10
-----------------------------
-
-In addition, there are two other applications that are built when the libraries are created.
-The source files for these are in the DPDK/app directory and are called test and testpmd.
-Once the libraries are created, they can be found in the build/app directory.
-
-*   The test application provides a variety of specific tests for the various functions in the DPDK.
-
-*   The testpmd application provides a number of different packet throughput tests and
-    examples of features such as how to use the Flow Director found in the Intel® 82599 10 Gigabit Ethernet Controller.

OK to remove the test applications from the page dedicated to samples. A lot of similar cleanup could be done if someone volunteers.

Quoted 2 lines
doc/guides/linux_gsg/enable_func.rst +0 -0

[...]

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module · line 134

Quoted 13 lines
doc/guides/linux_gsg/enable_func.rst +2 -7
@@ -128,13 +130,8 @@ Loading the DPDK KNI Kernel Module
 ----------------------------------
 
 To run the DPDK Kernel NIC Interface (KNI) sample application, an extra kernel module (the kni module) must be loaded into the running kernel.
-The module is found in the kmod sub-directory of the DPDK target directory.
-Similar to the loading of the ``igb_uio`` module, this module should be loaded using the insmod command as shown below
-(assuming that the current directory is the DPDK target directory):
-
-.. code-block:: console
-
-   insmod kmod/rte_kni.ko
+The module is found in the kernel/linux sub-directory of the DPDK build directory.
+This can be enabled in the same way as the ``igb_uio`` module, please see :ref:`load_uio` for details.

The only relevant info in "load_uio" chapter is to use insmod. I think it is better to keep some lines above:

It should be loaded using the insmod command::

insmod kmod/rte_kni.ko

doc/guides/linux_gsg/linux_drivers.rst Different PMDs may require different kernel drivers in order to work properly. · line 17

Quoted 9 lines
doc/guides/linux_gsg/linux_drivers.rst +3 -0
@@ -12,6 +12,9 @@ Different PMDs may require different kernel drivers in order to work properly.
 Depends on the PMD being used, a corresponding kernel driver should be load
 and bind to the network ports.
 
+.. _load_uio:
+
+

This anchor is not need in my opinion.

Quoted 16 lines
doc/guides/linux_gsg/linux_drivers.rst +2 -2
 UIO
 ---
 
@@ -28,19 +31,20 @@ can provide the uio capability. This module can be loaded using the command:
     ``uio_pci_generic`` module doesn't support the creation of virtual functions.
 
 As an alternative to the ``uio_pci_generic``, the DPDK also includes the igb_uio
-module which can be found in the kmod subdirectory referred to above. It can
+module which can be found in the kernel/linux subdirectory referred to above. It can
 be loaded as shown below:
 
 .. code-block:: console
 
     sudo modprobe uio
-    sudo insmod kmod/igb_uio.ko
+    sudo insmod <build_dir>/kernel/linux/igb_uio/igb_uio.ko

doc/guides/linux_gsg/linux_drivers.rst can provide the uio capability. This module can be loaded using the command: · line 47

Quoted 10 lines
doc/guides/linux_gsg/linux_drivers.rst +4 -3
 
 .. note::
 
-   ``igb_uio`` module is disabled by default starting from ``DPDK v20.02``.
-   To build it, the config option ``CONFIG_RTE_EAL_IGB_UIO`` should be enabled.
-   It is planned to move ``igb_uio`` module to a different git repository.
+   Building DPDK Linux kernel modules is disabled by default starting from DPDK v20.02.
+   To enable them again, the config option "enable_kmods" needs to be set in the meson
+   build configuration. See :ref:`adjusting_build_options` for details on how to set/clear
+   build options. It is planned to move ``igb_uio`` module to a different git repository.

In general it is better to split the lines logically to ease future patches diff.

#220 lore raw

Re: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide

- Ciara
-

Quoted 233 lines

-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Wednesday 30 September 2020 23:09
To: Power, Ciara <[email protected]>
Cc: [email protected]; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide

Hi,

Below are some comments. If you agree, I will do the changes myself while pushing to the main branch.

21/09/2020 15:59, Ciara Power:

doc/guides/linux_gsg/build_dpdk.rst and the last step causing the dynamic loader `ld.so`

Quoted 19 lines

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/linux_gsg/build_dpdk.rst        | 16 +++++++++++-----
 doc/guides/linux_gsg/build_sample_apps.rst | 18 +++---------------
 doc/guides/linux_gsg/enable_func.rst       | 13 +++++--------
 doc/guides/linux_gsg/linux_drivers.rst     | 18 +++++++++++-------
 doc/guides/linux_gsg/sys_reqs.rst          |  6 +-----
 5 files changed, 31 insertions(+), 40 deletions(-)
doc/guides/linux_gsg/build_dpdk.rst +0 -0
index a895e1b0f4..85d04520bf 100644
@@ -76,6 +76,8 @@ and the last step causing the dynamic loader `ld.so`

to update its cache to take

doc/guides/linux_gsg/build_dpdk.rst and the last step causing the dynamic loader `ld.so` to update its cache to take · line 80

Quoted 5 lines
doc/guides/linux_gsg/build_dpdk.rst +2 -0
    distributions, `/usr/local/lib` and `/usr/local/lib64` should be added
    to a file in `/etc/ld.so.conf.d/` before running `ldconfig`.
 
+.. _adjusting_build_options:
+

extra blank line

doc/guides/linux_gsg/build_dpdk.rst dependencies are met on the current system are

Quoted 4 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
 Adjusting Build Options
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -112,6 +114,9 @@ dependencies are met on the current system are

built.

Quoted 2 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
 When `-Dexamples=all` is set as a meson option, meson will check each

example application to see if it can be built, and add all which can be built

to the list of tasks in the ninja build configuration file.

doc/guides/linux_gsg/build_dpdk.rst

Quoted 4 lines

+.. _building_app_using_installed_dpdk:

doc/guides/linux_gsg/build_dpdk.rst +2 -0
+
+

extra blank line

doc/guides/linux_gsg/build_dpdk.rst and the sources for that build are stored in

Quoted 4 lines

Building Applications Using Installed DPDK
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/guides/linux_gsg/build_dpdk.rst +0 -0
@@ -135,11 +140,12 @@ and the sources for that build are stored in

``$(SRCS-y)``.

Quoted 4 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -1
 .. note::
 
-   Unlike with the older make build system, the meson system is not

doc/guides/linux_gsg/build_dpdk.rst and the sources for that build are stored in ``$(SRCS-y)``. · line 148

Quoted 10 lines
doc/guides/linux_gsg/build_dpdk.rst +6 -4
-   designed to be used directly from a build directory. Instead it is
-   recommended that it be installed either system-wide or to a known
-   location in the user's home directory. The install location can be set
-   using the `--prefix` meson option (default: `/usr/local`).
+   Unlike with the make build system present used in older DPDK releases,
+   the meson system is not designed to be used directly from a build
+   directory. Instead it is recommended that it be installed either
+   system-wide or to a known location in the user's home directory.
+   The install location can be set using the `--prefix` meson option
+   (default: `/usr/local`).

I prefer the first version.
The words "system present used" look weird.
Anyway, if any reword is needed, better to change only the impacted line and keep the rest of the line wrapping untouched.

Quoted 9 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
 an equivalent build recipe for a simple DPDK application using meson

as a build system is shown below:

doc/guides/linux_gsg/build_sample_apps.rst +0 -0
index 2882883f95..f4bf0e71e5 100644

doc/guides/linux_gsg/build_sample_apps.rst line 5

Quoted 6 lines
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -1,7 +1,7 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
-Compiling and Running Sample Applications
+Running Sample Applications
 =========================================

Underlining must be adjusted

doc/guides/linux_gsg/build_sample_apps.rst line 6

Quoted 2 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -0
 The chapter describes how to compile and run applications in an DPDK

environment.

Quoted 3 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -0
@@ -119,7 +119,7 @@ Copy the DPDK application binary to your target,

then run the application as fol (assuming the platform has four memory channels per processor socket, and that cores 0-3 are present and

are to be used for running the application)::

doc/guides/linux_gsg/build_sample_apps.rst If the DPDK cannot allocate enough memory on

Quoted 7 lines
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
-    ./helloworld -l 0-3 -n 4
+    ./dpdk-helloworld -l 0-3 -n 4
 
 .. note::
@@ -183,19 +183,7 @@ If the DPDK cannot allocate enough memory on

each

Quoted 4 lines

socket, the EAL initialization Additional Sample Applications
------------------------------

-Additional sample applications are included in the ${RTE_SDK}/examples

directory.

Quoted 1 line

+Additional sample applications are included in the DPDK examples

directory.

Quoted 1 line

These sample applications may be built and run in a manner similar to that

described in earlier sections in this manual.

Quoted 2 lines

In addition, see the *DPDK Sample Applications User Guide* for a
description of the application, specific instructions on compilation and

execution and some explanation of the code.

doc/guides/linux_gsg/build_sample_apps.rst If the DPDK cannot allocate enough memory on each socket, the EAL initialization

Quoted 5 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -5
-
-Additional Test Applications
-----------------------------
-
-In addition, there are two other applications that are built when the

libraries are created.

Quoted 1 line

-The source files for these are in the DPDK/app directory and are called test

and testpmd.

doc/guides/linux_gsg/build_sample_apps.rst If the DPDK cannot allocate enough memory on each socket, the EAL initialization

Quoted 3 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -3
-Once the libraries are created, they can be found in the build/app directory.
-
-*   The test application provides a variety of specific tests for the various

functions in the DPDK.

doc/guides/linux_gsg/build_sample_apps.rst

Quoted 2 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -2
-
-*   The testpmd application provides a number of different packet

throughput tests and

Quoted 1 line

- examples of features such as how to use the Flow Director found in the

Intel(r) 82599 10 Gigabit Ethernet Controller.

OK to remove the test applications from the page dedicated to samples. A lot of similar cleanup could be done if someone volunteers.

Quoted 2 lines
doc/guides/linux_gsg/enable_func.rst +0 -0

[...]

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module · line 132

Quoted 4 lines
doc/guides/linux_gsg/enable_func.rst +0 -0
@@ -128,13 +130,8 @@ Loading the DPDK KNI Kernel Module
 ----------------------------------
 
 To run the DPDK Kernel NIC Interface (KNI) sample application, an extra

kernel module (the kni module) must be loaded into the running kernel.

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module · line 131

Quoted 1 line
doc/guides/linux_gsg/enable_func.rst +0 -1
-The module is found in the kmod sub-directory of the DPDK target

directory.

Quoted 2 lines
doc/guides/linux_gsg/enable_func.rst +0 -1
-Similar to the loading of the ``igb_uio`` module, this module should

be loaded using the insmod command as shown below -(assuming that the

current directory is the DPDK target directory):

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module

Quoted 5 lines
doc/guides/linux_gsg/enable_func.rst +1 -4
-
-.. code-block:: console
-
-   insmod kmod/rte_kni.ko
+The module is found in the kernel/linux sub-directory of the DPDK build

directory.

Quoted 1 line

+This can be enabled in the same way as the ``igb_uio`` module, please see

:ref:load_uio for details.

The only relevant info in "load_uio" chapter is to use insmod. I think it is better to keep some lines above:

It should be loaded using the insmod command::

insmod kmod/rte_kni.ko

doc/guides/linux_gsg/linux_drivers.rst Different PMDs may require different kernel drivers in

Quoted 3 lines
doc/guides/linux_gsg/linux_drivers.rst +0 -0
@@ -12,6 +12,9 @@ Different PMDs may require different kernel drivers in

order to work properly.

doc/guides/linux_gsg/linux_drivers.rst

Quoted 6 lines
doc/guides/linux_gsg/linux_drivers.rst +0 -0
 Depends on the PMD being used, a corresponding kernel driver should

be load and bind to the network ports.

+.. _load_uio:

doc/guides/linux_gsg/linux_drivers.rst +2 -0
+
+

This anchor is not need in my opinion.

doc/guides/linux_gsg/linux_drivers.rst can provide the uio capability. This module can be

Quoted 4 lines

UIO
---

doc/guides/linux_gsg/linux_drivers.rst +0 -0
@@ -28,19 +31,20 @@ can provide the uio capability. This module can be

loaded using the command:

doc/guides/linux_gsg/linux_drivers.rst can provide the uio capability. This module can be · line 31

Quoted 1 line
doc/guides/linux_gsg/linux_drivers.rst +0 -0
     ``uio_pci_generic`` module doesn't support the creation of virtual

functions.

Quoted 8 lines
doc/guides/linux_gsg/linux_drivers.rst +0 -0
 As an alternative to the ``uio_pci_generic``, the DPDK also includes

the igb_uio -module which can be found in the kmod subdirectory referred to above. It can

doc/guides/linux_gsg/linux_drivers.rst +2 -0
+module which can be found in the kernel/linux subdirectory referred
+to above. It can
 be loaded as shown below:
 

doc/guides/linux_gsg/linux_drivers.rst can provide the uio capability. This module can be loaded using the command:

Quoted 10 lines
doc/guides/linux_gsg/linux_drivers.rst +1 -3
 .. code-block:: console
 
     sudo modprobe uio
-    sudo insmod kmod/igb_uio.ko
+    sudo insmod <build_dir>/kernel/linux/igb_uio/igb_uio.ko
 
 .. note::
 
-   ``igb_uio`` module is disabled by default starting from ``DPDK v20.02``.
-   To build it, the config option ``CONFIG_RTE_EAL_IGB_UIO`` should be

enabled.

doc/guides/linux_gsg/linux_drivers.rst

Quoted 2 lines
doc/guides/linux_gsg/linux_drivers.rst +1 -1
-   It is planned to move ``igb_uio`` module to a different git repository.
+   Building DPDK Linux kernel modules is disabled by default starting from

DPDK v20.02.

Quoted 1 line

+ To enable them again, the config option "enable_kmods" needs to be set

in the meson

Quoted 1 line

+ build configuration. See :ref:adjusting_build_options for details on how

to set/clear

Quoted 1 line

+ build options. It is planned to move ``igb_uio`` module to a different git

repository.

In general it is better to split the lines logically to ease future patches diff.

#221 lore raw

Re: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide

In reply to Thomas Monjalon

Hi Thomas,

Apologies for the previous email, accidentally sent before I could fill it in!

Most of these suggestions seem fine to me, left some comments inline.

Thanks,
Ciara

Quoted 36 lines

-----Original Message-----
From: Thomas Monjalon <[email protected]>
Sent: Wednesday 30 September 2020 23:09
To: Power, Ciara <[email protected]>
Cc: [email protected]; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>
Subject: Re: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide

Hi,

Below are some comments. If you agree, I will do the changes myself while pushing to the main branch.

21/09/2020 15:59, Ciara Power:

doc/guides/linux_gsg/build_dpdk.rst and the last step causing the dynamic loader `ld.so`

Quoted 19 lines

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/linux_gsg/build_dpdk.rst        | 16 +++++++++++-----
 doc/guides/linux_gsg/build_sample_apps.rst | 18 +++---------------
 doc/guides/linux_gsg/enable_func.rst       | 13 +++++--------
 doc/guides/linux_gsg/linux_drivers.rst     | 18 +++++++++++-------
 doc/guides/linux_gsg/sys_reqs.rst          |  6 +-----
 5 files changed, 31 insertions(+), 40 deletions(-)
doc/guides/linux_gsg/build_dpdk.rst +0 -0
index a895e1b0f4..85d04520bf 100644
@@ -76,6 +76,8 @@ and the last step causing the dynamic loader `ld.so`

to update its cache to take

Quoted 7 lines

doc/guides/linux_gsg/build_dpdk.rst and the last step causing the dynamic loader `ld.so` to update its cache to take · line 80

Quoted 5 lines
doc/guides/linux_gsg/build_dpdk.rst +2 -0
    distributions, `/usr/local/lib` and `/usr/local/lib64` should be added
    to a file in `/etc/ld.so.conf.d/` before running `ldconfig`.
 
+.. _adjusting_build_options:
+

extra blank line

Blank line here, and below, were added based on the contributing guide - " Add 2 blank lines before each section header." Okay to remove if that has changed.

Quoted 36 lines

doc/guides/linux_gsg/build_dpdk.rst dependencies are met on the current system are

Quoted 5 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
 Adjusting Build Options
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -112,6 +114,9 @@ dependencies are met on the current system are

built.

Quoted 2 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
 When `-Dexamples=all` is set as a meson option, meson will check each

example application to see if it can be built, and add all which can be built

to the list of tasks in the ninja build configuration file.

doc/guides/linux_gsg/build_dpdk.rst

Quoted 4 lines

+.. _building_app_using_installed_dpdk:

doc/guides/linux_gsg/build_dpdk.rst +2 -0
+
+

extra blank line

doc/guides/linux_gsg/build_dpdk.rst and the sources for that build are stored in

Quoted 4 lines

Building Applications Using Installed DPDK
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/guides/linux_gsg/build_dpdk.rst +0 -0
@@ -135,11 +140,12 @@ and the sources for that build are stored in

``$(SRCS-y)``.

Quoted 4 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -1
 .. note::
 
-   Unlike with the older make build system, the meson system is not

doc/guides/linux_gsg/build_dpdk.rst and the sources for that build are stored in ``$(SRCS-y)``. · line 148

Quoted 10 lines
doc/guides/linux_gsg/build_dpdk.rst +6 -4
-   designed to be used directly from a build directory. Instead it is
-   recommended that it be installed either system-wide or to a known
-   location in the user's home directory. The install location can be set
-   using the `--prefix` meson option (default: `/usr/local`).
+   Unlike with the make build system present used in older DPDK releases,
+   the meson system is not designed to be used directly from a build
+   directory. Instead it is recommended that it be installed either
+   system-wide or to a known location in the user's home directory.
+   The install location can be set using the `--prefix` meson option
+   (default: `/usr/local`).
Quoted 5 lines

I prefer the first version.
The words "system present used" look weird.
Anyway, if any reword is needed, better to change only the impacted line and keep the rest of the line wrapping untouched.

I think this was a typo on the first line, should have been either "present" or "used", not both.

Quoted 86 lines
Quoted 9 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
 an equivalent build recipe for a simple DPDK application using meson

as a build system is shown below:

doc/guides/linux_gsg/build_sample_apps.rst +0 -0
index 2882883f95..f4bf0e71e5 100644

doc/guides/linux_gsg/build_sample_apps.rst line 5

Quoted 6 lines
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
@@ -1,7 +1,7 @@
 ..  SPDX-License-Identifier: BSD-3-Clause
     Copyright(c) 2010-2014 Intel Corporation.
 
-Compiling and Running Sample Applications
+Running Sample Applications
 =========================================

Underlining must be adjusted

doc/guides/linux_gsg/build_sample_apps.rst line 6

Quoted 2 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -0
 The chapter describes how to compile and run applications in an DPDK

environment.

Quoted 3 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -0
@@ -119,7 +119,7 @@ Copy the DPDK application binary to your target,

then run the application as fol (assuming the platform has four memory channels per processor socket, and that cores 0-3 are present and

are to be used for running the application)::

doc/guides/linux_gsg/build_sample_apps.rst If the DPDK cannot allocate enough memory on

Quoted 7 lines
doc/guides/linux_gsg/build_sample_apps.rst +1 -1
-    ./helloworld -l 0-3 -n 4
+    ./dpdk-helloworld -l 0-3 -n 4
 
 .. note::
@@ -183,19 +183,7 @@ If the DPDK cannot allocate enough memory on

each

Quoted 4 lines

socket, the EAL initialization Additional Sample Applications
------------------------------

-Additional sample applications are included in the ${RTE_SDK}/examples

directory.

Quoted 1 line

+Additional sample applications are included in the DPDK examples

directory.

Quoted 1 line

These sample applications may be built and run in a manner similar to that

described in earlier sections in this manual.

Quoted 2 lines

In addition, see the *DPDK Sample Applications User Guide* for a
description of the application, specific instructions on compilation and

execution and some explanation of the code.

doc/guides/linux_gsg/build_sample_apps.rst If the DPDK cannot allocate enough memory on each socket, the EAL initialization

Quoted 5 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -5
-
-Additional Test Applications
-----------------------------
-
-In addition, there are two other applications that are built when the

libraries are created.

Quoted 1 line

-The source files for these are in the DPDK/app directory and are called test

and testpmd.

doc/guides/linux_gsg/build_sample_apps.rst If the DPDK cannot allocate enough memory on each socket, the EAL initialization

Quoted 3 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -3
-Once the libraries are created, they can be found in the build/app directory.
-
-*   The test application provides a variety of specific tests for the various

functions in the DPDK.

doc/guides/linux_gsg/build_sample_apps.rst

Quoted 2 lines
doc/guides/linux_gsg/build_sample_apps.rst +0 -2
-
-*   The testpmd application provides a number of different packet

throughput tests and

Quoted 1 line

- examples of features such as how to use the Flow Director found in the

Intel(r) 82599 10 Gigabit Ethernet Controller.

OK to remove the test applications from the page dedicated to samples. A lot of similar cleanup could be done if someone volunteers.

Quoted 2 lines
doc/guides/linux_gsg/enable_func.rst +0 -0

[...]

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module · line 132

Quoted 4 lines
doc/guides/linux_gsg/enable_func.rst +0 -0
@@ -128,13 +130,8 @@ Loading the DPDK KNI Kernel Module
 ----------------------------------
 
 To run the DPDK Kernel NIC Interface (KNI) sample application, an extra

kernel module (the kni module) must be loaded into the running kernel.

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module · line 131

Quoted 1 line
doc/guides/linux_gsg/enable_func.rst +0 -1
-The module is found in the kmod sub-directory of the DPDK target

directory.

Quoted 2 lines
doc/guides/linux_gsg/enable_func.rst +0 -1
-Similar to the loading of the ``igb_uio`` module, this module should

be loaded using the insmod command as shown below -(assuming that the

current directory is the DPDK target directory):

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module

Quoted 5 lines
doc/guides/linux_gsg/enable_func.rst +1 -4
-
-.. code-block:: console
-
-   insmod kmod/rte_kni.ko
+The module is found in the kernel/linux sub-directory of the DPDK build

directory.

Quoted 1 line

+This can be enabled in the same way as the ``igb_uio`` module, please see

Quoted 8 lines

:ref:load_uio for details.

The only relevant info in "load_uio" chapter is to use insmod. I think it is better to keep some lines above:

It should be loaded using the insmod command::

insmod kmod/rte_kni.ko

I think this should be the updated path:
" <build_dir>/kernel/linux/kni/rte_kni.ko"

Quoted 55 lines

doc/guides/linux_gsg/linux_drivers.rst Different PMDs may require different kernel drivers in

Quoted 4 lines
doc/guides/linux_gsg/linux_drivers.rst +0 -0
@@ -12,6 +12,9 @@ Different PMDs may require different kernel drivers in

order to work properly.

doc/guides/linux_gsg/linux_drivers.rst

Quoted 6 lines
doc/guides/linux_gsg/linux_drivers.rst +0 -0
 Depends on the PMD being used, a corresponding kernel driver should

be load and bind to the network ports.

+.. _load_uio:

doc/guides/linux_gsg/linux_drivers.rst +2 -0
+
+

This anchor is not need in my opinion.

doc/guides/linux_gsg/linux_drivers.rst can provide the uio capability. This module can be

Quoted 4 lines

UIO
---

doc/guides/linux_gsg/linux_drivers.rst +0 -0
@@ -28,19 +31,20 @@ can provide the uio capability. This module can be

loaded using the command:

doc/guides/linux_gsg/linux_drivers.rst can provide the uio capability. This module can be · line 31

Quoted 1 line
doc/guides/linux_gsg/linux_drivers.rst +0 -0
     ``uio_pci_generic`` module doesn't support the creation of virtual

functions.

Quoted 8 lines
doc/guides/linux_gsg/linux_drivers.rst +0 -0
 As an alternative to the ``uio_pci_generic``, the DPDK also includes

the igb_uio -module which can be found in the kmod subdirectory referred to above. It can

doc/guides/linux_gsg/linux_drivers.rst +2 -0
+module which can be found in the kernel/linux subdirectory referred
+to above. It can
 be loaded as shown below:
 

doc/guides/linux_gsg/linux_drivers.rst can provide the uio capability. This module can be loaded using the command:

Quoted 10 lines
doc/guides/linux_gsg/linux_drivers.rst +1 -3
 .. code-block:: console
 
     sudo modprobe uio
-    sudo insmod kmod/igb_uio.ko
+    sudo insmod <build_dir>/kernel/linux/igb_uio/igb_uio.ko
 
 .. note::
 
-   ``igb_uio`` module is disabled by default starting from ``DPDK v20.02``.
-   To build it, the config option ``CONFIG_RTE_EAL_IGB_UIO`` should be

enabled.

doc/guides/linux_gsg/linux_drivers.rst

Quoted 2 lines
doc/guides/linux_gsg/linux_drivers.rst +1 -1
-   It is planned to move ``igb_uio`` module to a different git repository.
+   Building DPDK Linux kernel modules is disabled by default starting from

DPDK v20.02.

Quoted 1 line

+ To enable them again, the config option "enable_kmods" needs to be set

in the meson

Quoted 1 line

+ build configuration. See :ref:adjusting_build_options for details on how

to set/clear

Quoted 1 line

+ build options. It is planned to move ``igb_uio`` module to a different git

repository.

In general it is better to split the lines logically to ease future patches diff.

#222 lore raw

Re: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide

01/10/2020 10:36, Power, Ciara:

Quoted 32 lines

From: Thomas Monjalon <[email protected]>

Quoted 31 lines

Hi,

Below are some comments. If you agree, I will do the changes myself while pushing to the main branch.

21/09/2020 15:59, Ciara Power:

doc/guides/linux_gsg/build_dpdk.rst and the last step causing the dynamic loader `ld.so`

Quoted 19 lines

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/linux_gsg/build_dpdk.rst        | 16 +++++++++++-----
 doc/guides/linux_gsg/build_sample_apps.rst | 18 +++---------------
 doc/guides/linux_gsg/enable_func.rst       | 13 +++++--------
 doc/guides/linux_gsg/linux_drivers.rst     | 18 +++++++++++-------
 doc/guides/linux_gsg/sys_reqs.rst          |  6 +-----
 5 files changed, 31 insertions(+), 40 deletions(-)
doc/guides/linux_gsg/build_dpdk.rst +0 -0
index a895e1b0f4..85d04520bf 100644
@@ -76,6 +76,8 @@ and the last step causing the dynamic loader `ld.so`

to update its cache to take

Quoted 3 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
    distributions, `/usr/local/lib` and `/usr/local/lib64` should be added
    to a file in `/etc/ld.so.conf.d/` before running `ldconfig`.
 
Quoted 7 lines
Quoted 4 lines

doc/guides/linux_gsg/build_dpdk.rst and the last step causing the dynamic loader `ld.so` to update its cache to take · line 80

Quoted 2 lines
doc/guides/linux_gsg/build_dpdk.rst +2 -0
+.. _adjusting_build_options:
+

extra blank line

Blank line here, and below, were added based on the contributing guide - " Add 2 blank lines before each section header." Okay to remove if that has changed.

Yes, the recommendation is 2 blank lines to separate a paragraph from the next title. But here it is an anchor for the next title, so it should be grouped together.

Quoted 34 lines
Quoted 34 lines

doc/guides/linux_gsg/build_dpdk.rst dependencies are met on the current system are

Quoted 3 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
 Adjusting Build Options
 ~~~~~~~~~~~~~~~~~~~~~~~
@@ -112,6 +114,9 @@ dependencies are met on the current system are

built.

Quoted 2 lines
doc/guides/linux_gsg/build_dpdk.rst +0 -0
 When `-Dexamples=all` is set as a meson option, meson will check each

example application to see if it can be built, and add all which can be built

to the list of tasks in the ninja build configuration file.

doc/guides/linux_gsg/build_dpdk.rst

Quoted 4 lines

+.. _building_app_using_installed_dpdk:

doc/guides/linux_gsg/build_dpdk.rst +2 -0
+
+

extra blank line

doc/guides/linux_gsg/build_dpdk.rst and the sources for that build are stored in

Quoted 4 lines

Building Applications Using Installed DPDK
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

doc/guides/linux_gsg/build_dpdk.rst +0 -0
@@ -135,11 +140,12 @@ and the sources for that build are stored in

``$(SRCS-y)``.

Quoted 14 lines
doc/guides/linux_gsg/build_dpdk.rst +6 -5
 .. note::
 
-   Unlike with the older make build system, the meson system is not
-   designed to be used directly from a build directory. Instead it is
-   recommended that it be installed either system-wide or to a known
-   location in the user's home directory. The install location can be set
-   using the `--prefix` meson option (default: `/usr/local`).
+   Unlike with the make build system present used in older DPDK releases,
+   the meson system is not designed to be used directly from a build
+   directory. Instead it is recommended that it be installed either
+   system-wide or to a known location in the user's home directory.
+   The install location can be set using the `--prefix` meson option
+   (default: `/usr/local`).
Quoted 6 lines
Quoted 5 lines

I prefer the first version.
The words "system present used" look weird.
Anyway, if any reword is needed, better to change only the impacted line and keep the rest of the line wrapping untouched.

I think this was a typo on the first line, should have been either "present" or "used", not both.

OK will fix.

[...]

Quoted 25 lines
Quoted 25 lines
Quoted 2 lines
doc/guides/linux_gsg/enable_func.rst +0 -0

[...]

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module · line 132

Quoted 4 lines
doc/guides/linux_gsg/enable_func.rst +0 -0
@@ -128,13 +130,8 @@ Loading the DPDK KNI Kernel Module
 ----------------------------------
 
 To run the DPDK Kernel NIC Interface (KNI) sample application, an extra

kernel module (the kni module) must be loaded into the running kernel.

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module · line 131

Quoted 1 line
doc/guides/linux_gsg/enable_func.rst +0 -1
-The module is found in the kmod sub-directory of the DPDK target

directory.

Quoted 2 lines
doc/guides/linux_gsg/enable_func.rst +0 -1
-Similar to the loading of the ``igb_uio`` module, this module should

be loaded using the insmod command as shown below -(assuming that the

current directory is the DPDK target directory):

doc/guides/linux_gsg/enable_func.rst Loading the DPDK KNI Kernel Module

Quoted 5 lines
doc/guides/linux_gsg/enable_func.rst +1 -4
-
-.. code-block:: console
-
-   insmod kmod/rte_kni.ko
+The module is found in the kernel/linux sub-directory of the DPDK build

directory.

Quoted 1 line

+This can be enabled in the same way as the ``igb_uio`` module, please see

:ref:load_uio for details.

The only relevant info in "load_uio" chapter is to use insmod. I think it is better to keep some lines above:

Quoted 6 lines
Quoted 3 lines

It should be loaded using the insmod command::

insmod kmod/rte_kni.ko

I think this should be the updated path:
" <build_dir>/kernel/linux/kni/rte_kni.ko"

Yes of course.
Thanks

#223 lore raw

PATCH v5 4/20 doc: remove references to make from FreeBSD guide

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/freebsd_gsg/build_dpdk.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
doc/guides/freebsd_gsg/build_dpdk.rst +1 -1
index e31c966b98..1e5a8cfe9e 100644
@@ -122,7 +122,7 @@ up time.  This can be achieved by placing lines similar to the following into
 
 An error such as::
 
-    kldload: can't load ./x86_64-native-freebsd-gcc/kmod/contigmem.ko:
+    kldload: can't load ./<build_dir>/kernel/freebsd/contigmem.ko:
              Exec format error
 
 is generally attributed to not having enough contiguous memory
Signature · 1 line
2.17.1
#224 lore raw

PATCH v5 5/20 doc: remove references to make from howto guides

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/howto/lm_bond_virtio_sriov.rst     |  4 +--
 doc/guides/howto/lm_virtio_vhost_user.rst     |  4 +--
 doc/guides/howto/packet_capture_framework.rst | 21 +++------------
 doc/guides/howto/pvp_reference_benchmark.rst  | 27 +++++--------------
 doc/guides/howto/vfd.rst                      |  4 +--
 .../virtio_user_for_container_networking.rst  |  2 +-
 6 files changed, 16 insertions(+), 46 deletions(-)
doc/guides/howto/lm_bond_virtio_sriov.rst +2 -2
index 07563b3e24..02ba1cdf5d 100644
@@ -591,7 +591,7 @@ Set up DPDK in the Virtual Machine
    rmmod virtio-pci ixgbevf
 
    modprobe uio
-   insmod /root/dpdk/x86_64-default-linux-gcc/kmod/igb_uio.ko
+   insmod /root/dpdk/<build_dir>/kernel/linux/igb_uio/igb_uio.ko
 
    /root/dpdk/usertools/dpdk-devbind.py -b igb_uio 0000:00:03.0
    /root/dpdk/usertools/dpdk-devbind.py -b igb_uio 0000:00:04.0
@@ -613,7 +613,7 @@ Run testpmd in the Virtual Machine.
 
    # use for bonding of virtio and vf tests in VM
 
-   /root/dpdk/x86_64-default-linux-gcc/app/testpmd \
+   /root/dpdk/<build_dir>/app/dpdk-testpmd \
    -l 0-3 -n 4 --socket-mem 350 --  --i --port-topology=chained
 
 .. _lm_bond_virtio_sriov_switch_conf:
doc/guides/howto/lm_virtio_vhost_user.rst +2 -2
index ecb7832906..330ff5a9c8 100644
@@ -421,7 +421,7 @@ setup_dpdk_virtio_in_vm.sh
    rmmod virtio-pci
 
    modprobe uio
-   insmod /root/dpdk/x86_64-default-linux-gcc/kmod/igb_uio.ko
+   insmod /root/dpdk/<build_dir>/kernel/linux/igb_uio/igb_uio.ko
 
    /root/dpdk/usertools/dpdk-devbind.py -b igb_uio 0000:00:03.0
    /root/dpdk/usertools/dpdk-devbind.py -b igb_uio 0000:00:04.0
@@ -437,5 +437,5 @@ run_testpmd_in_vm.sh
    # Run testpmd for use with vhost_user sample app.
    # test system has 8 cpus (0-7), use cpus 2-7 for VM
 
-   /root/dpdk/x86_64-default-linux-gcc/app/testpmd \
+   /root/dpdk/<build_dir>/app/dpdk-testpmd \
    -l 0-5 -n 4 --socket-mem 350 -- --burst=64 --i
doc/guides/howto/packet_capture_framework.rst +3 -18
index 946a21c8ed..d457989607 100644
@@ -52,11 +52,7 @@ Some things to note:
   initialization code. Refer to the ``app/test-pmd/testpmd.c`` code and look
   for ``pdump`` keyword to see how this is done.
 
-* The ``dpdk-pdump`` tool depends on the libpcap based PMD which is disabled
-  by default in the build configuration files, owing to an external dependency
-  on the libpcap development files. Once the libpcap development files are
-  installed, the libpcap based PMD can be enabled by setting
-  ``CONFIG_RTE_LIBRTE_PMD_PCAP=y`` and recompiling the DPDK.
+* The ``dpdk-pdump`` tool depends on the libpcap based PMD.
 
 
 Test Environment
@@ -73,17 +69,6 @@ for packet capturing on the DPDK port in
    Packet capturing on a DPDK port using the dpdk-pdump tool.
 
 
-Configuration
--------------
-
-Modify the DPDK primary application to initialize the packet capture framework
-as mentioned in the above notes and enable the following config options and
-build DPDK::
-
-     CONFIG_RTE_LIBRTE_PMD_PCAP=y
-     CONFIG_RTE_LIBRTE_PDUMP=y
-
-
 Running the Application
 -----------------------
 
@@ -93,11 +78,11 @@ inspect them using ``tcpdump``.
 
 #. Launch testpmd as the primary application::
 
-     sudo ./app/testpmd -c 0xf0 -n 4 -- -i --port-topology=chained
+     sudo ./<build_dir>/app/dpdk-testpmd -c 0xf0 -n 4 -- -i --port-topology=chained
 
 #. Launch the pdump tool as follows::
 
-     sudo ./build/app/dpdk-pdump -- \
+     sudo ./<build_dir>/app/dpdk-pdump -- \
           --pdump 'port=0,queue=*,rx-dev=/tmp/capture.pcap'
 
 #. Send traffic to dpdk_port0 from traffic generator.
doc/guides/howto/pvp_reference_benchmark.rst +6 -21
index 64b1f4d8ec..1d4a4b0232 100644
@@ -99,14 +99,7 @@ Build Qemu:
 DPDK build
 ~~~~~~~~~~
 
-Build DPDK:
-
-   .. code-block:: console
-
-      git clone git://dpdk.org/dpdk
-      cd dpdk
-      export RTE_SDK=$PWD
-      make install T=x86_64-native-linux-gcc DESTDIR=install
+See :doc:`../linux_gsg/build_dpdk` for details.
 
 
 Testpmd launch
@@ -117,7 +110,7 @@ Testpmd launch
    .. code-block:: console
 
       modprobe vfio-pci
-      $RTE_SDK/install/sbin/dpdk-devbind -b vfio-pci 0000:11:00.0 0000:11:00.1
+      ./dpdk/usertools/dpdk-devbind -b vfio-pci 0000:11:00.0 0000:11:00.1
 
    .. Note::
 
@@ -129,7 +122,7 @@ Testpmd launch
 
    .. code-block:: console
 
-      $RTE_SDK/install/bin/testpmd -l 0,2,3,4,5 --socket-mem=1024 -n 4 \
+      ./dpdk/<build_dir>/app/dpdk-testpmd -l 0,2,3,4,5 --socket-mem=1024 -n 4 \
           --vdev 'net_vhost0,iface=/tmp/vhost-user1' \
           --vdev 'net_vhost1,iface=/tmp/vhost-user2' -- \
           --portmask=f -i --rxq=1 --txq=1 \
@@ -309,18 +302,10 @@ Guest tuning
         echo "obase=16;$(( 0x$(cat $i) & ~$clear_mask ))" | bc > $i
       done
 
-
 DPDK build
 ~~~~~~~~~~
 
-Build DPDK:
-
-   .. code-block:: console
-
-      git clone git://dpdk.org/dpdk
-      cd dpdk
-      export RTE_SDK=$PWD
-      make install T=x86_64-native-linux-gcc DESTDIR=install
+See :doc:`../linux_gsg/build_dpdk` for details.
 
 
 Testpmd launch
@@ -340,13 +325,13 @@ Bind the virtio-net devices to DPDK:
 
    .. code-block:: console
 
-      $RTE_SDK/usertools/dpdk-devbind.py -b vfio-pci 0000:00:10.0 0000:00:11.0
+      ./dpdk/usertools/dpdk-devbind.py -b vfio-pci 0000:00:10.0 0000:00:11.0
 
 Start testpmd:
 
    .. code-block:: console
 
-      $RTE_SDK/install/bin/testpmd -l 0,1,2 --socket-mem 1024 -n 4 \
+      ./dpdk/<build_dir>/app/dpdk-testpmd -l 0,1,2 --socket-mem 1024 -n 4 \
           --proc-type auto --file-prefix pg -- \
           --portmask=3 --forward-mode=macswap --port-topology=chained \
           --disable-rss -i --rxq=1 --txq=1 \
doc/guides/howto/vfd.rst +2 -2
index 0ec0a0478d..5a62e6ff5a 100644
@@ -83,7 +83,7 @@ The typical procedure to achieve this is as follows:
 
 #. Run a DPDK application on the PF in the host::
 
-      testpmd -l 0-7 -n 4 -- -i --txqflags=0
+      dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0
 
 #. Bind the VF port to ``igb_uio`` in the VM::
 
@@ -91,7 +91,7 @@ The typical procedure to achieve this is as follows:
 
 #. Run a DPDK application on the VF in the VM::
 
-      testpmd -l 0-7 -n 4 -- -i --txqflags=0
+      dpdk-testpmd -l 0-7 -n 4 -- -i --txqflags=0
 
 
 Common functions of IXGBE and I40E
doc/guides/howto/virtio_user_for_container_networking.rst +1 -1
index 412b29664b..5eab360a1c 100644
@@ -64,7 +64,7 @@ some minor changes.
 	FROM ubuntu:latest
 	WORKDIR /usr/src/dpdk
 	COPY . /usr/src/dpdk
-	ENV PATH "$PATH:/usr/src/dpdk/x86_64-native-linux-gcc/app/"
+	ENV PATH "$PATH:/usr/src/dpdk/<build_dir>/app/"
 	EOT
 
 #. Build a Docker image.
Signature · 1 line
2.17.1
#225 lore raw

PATCH v5 6/20 doc: remove references to make from prog guide

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/prog_guide/env_abstraction_layer.rst | 17 ++++++-----------
 doc/guides/prog_guide/graph_lib.rst             |  6 ++----
 .../prog_guide/ip_fragment_reassembly_lib.rst   |  5 -----
 doc/guides/prog_guide/kernel_nic_interface.rst  | 14 +++++++-------
 .../link_bonding_poll_mode_drv_lib.rst          | 15 ++++++++-------
 doc/guides/prog_guide/lto.rst                   | 12 +-----------
 doc/guides/prog_guide/mbuf_lib.rst              |  4 ++--
 doc/guides/prog_guide/mempool_lib.rst           |  7 +++----
 doc/guides/prog_guide/profile_app.rst           | 17 +++--------------
 doc/guides/prog_guide/qos_framework.rst         | 10 +---------
 doc/guides/prog_guide/rcu_lib.rst               |  7 +++----
 doc/guides/prog_guide/trace_lib.rst             |  3 +--
 .../prog_guide/writing_efficient_code.rst       |  3 +--
 13 files changed, 38 insertions(+), 82 deletions(-)
doc/guides/prog_guide/env_abstraction_layer.rst +6 -11
index f64ae953d1..936c885081 100644
@@ -201,16 +201,16 @@ each segment is strictly one physical page. It is possible to change the amount
 of virtual memory being preallocated at startup by editing the following config
 variables:
 
-* ``CONFIG_RTE_MAX_MEMSEG_LISTS`` controls how many segment lists can DPDK have
-* ``CONFIG_RTE_MAX_MEM_MB_PER_LIST`` controls how much megabytes of memory each
+* ``RTE_MAX_MEMSEG_LISTS`` controls how many segment lists can DPDK have
+* ``RTE_MAX_MEM_MB_PER_LIST`` controls how much megabytes of memory each
   segment list can address
-* ``CONFIG_RTE_MAX_MEMSEG_PER_LIST`` controls how many segments each segment can
+* ``RTE_MAX_MEMSEG_PER_LIST`` controls how many segments each segment can
   have
-* ``CONFIG_RTE_MAX_MEMSEG_PER_TYPE`` controls how many segments each memory type
+* ``RTE_MAX_MEMSEG_PER_TYPE`` controls how many segments each memory type
   can have (where "type" is defined as "page size + NUMA node" combination)
-* ``CONFIG_RTE_MAX_MEM_MB_PER_TYPE`` controls how much megabytes of memory each
+* ``RTE_MAX_MEM_MB_PER_TYPE`` controls how much megabytes of memory each
   memory type can address
-* ``CONFIG_RTE_MAX_MEM_MB`` places a global maximum on the amount of memory
+* ``RTE_MAX_MEM_MB`` places a global maximum on the amount of memory
   DPDK can reserve
 
 Normally, these options do not need to be changed.
@@ -715,11 +715,6 @@ However, they can be used in configuration code.
 Refer to the rte_malloc() function description in the *DPDK API Reference*
 manual for more information.
 
-Cookies
-~~~~~~~
-
-When CONFIG_RTE_MALLOC_DEBUG is enabled, the allocated memory contains
-overwrite protection fields to help identify buffer overflows.
 
 Alignment and NUMA Constraints
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
doc/guides/prog_guide/graph_lib.rst +2 -4
index 669d77c740..c922d10f3d 100644
@@ -45,13 +45,11 @@ Performance tuning parameters
 -----------------------------
 
 - Test with various burst size values (256, 128, 64, 32) using
-  CONFIG_RTE_GRAPH_BURST_SIZE config option.
+  RTE_GRAPH_BURST_SIZE config option.
   The testing shows, on x86 and arm64 servers, The sweet spot is 256 burst
   size. While on arm64 embedded SoCs, it is either 64 or 128.
-- Disable node statistics (using ``CONFIG_RTE_LIBRTE_GRAPH_STATS`` config option)
+- Disable node statistics (using ``RTE_LIBRTE_GRAPH_STATS`` config option)
   if not needed.
-- Use arm64 optimized memory copy for arm64 architecture by
-  selecting ``CONFIG_RTE_ARCH_ARM64_MEMCPY``.
 
 Programming model
 -----------------
doc/guides/prog_guide/ip_fragment_reassembly_lib.rst +0 -5
index 6ac1bba649..314d4adbb8 100644
@@ -103,8 +103,3 @@ Debug logging and Statistics Collection
 
 The RTE_LIBRTE_IP_FRAG_TBL_STAT config macro controls statistics collection for the Fragment Table.
 This macro is not enabled by default.
-
-The RTE_LIBRTE_IP_FRAG_DEBUG controls debug logging of IP fragments processing and reassembling.
-This macro is disabled by default.
-Note that while logging contains a lot of detailed information,
-it slows down packet processing and might cause the loss of a lot of packets.
doc/guides/prog_guide/kernel_nic_interface.rst +7 -7
index 32d09ccf82..de5d75bd4c 100644
@@ -65,7 +65,7 @@ disabled, and the default carrier state of KNI interfaces is set to *off*.
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko
 
 .. _kni_loopback_mode:
 
@@ -77,14 +77,14 @@ by specifying the ``lo_mode`` parameter:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko lo_mode=lo_mode_fifo
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo
 
 The ``lo_mode_fifo`` loopback option will loop back ring enqueue/dequeue
 operations in kernel space.
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko lo_mode=lo_mode_fifo_skb
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo_skb
 
 The ``lo_mode_fifo_skb`` loopback option will loop back ring enqueue/dequeue
 operations and sk buffer copies in kernel space.
@@ -105,7 +105,7 @@ Single kernel thread mode is enabled as follows:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko kthread_mode=single
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko kthread_mode=single
 
 This mode will create only one kernel thread for all KNI interfaces to
 receive data on the kernel side.  By default, this kernel thread is not
@@ -122,7 +122,7 @@ kernel thread mode is enabled as follows:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko kthread_mode=multiple
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko kthread_mode=multiple
 
 This mode will create a separate kernel thread for each KNI interface to
 receive data on the kernel side.  The core affinity of each ``kni_thread``
@@ -163,13 +163,13 @@ To set the default carrier state to *on*:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko carrier=on
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko carrier=on
 
 To set the default carrier state to *off*:
 
 .. code-block:: console
 
-    # insmod kmod/rte_kni.ko carrier=off
+    # insmod <build_dir>/kernel/linux/kni/rte_kni.ko carrier=off
 
 If the ``carrier`` parameter is not specified, the default carrier state
 of KNI interfaces will be set to *off*.
doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst +8 -7
index 2459fd243e..244dca56c4 100644
@@ -28,8 +28,9 @@ bonded device and its slave devices.
 .. note::
 
     The Link Bonding PMD Library is enabled by default in the build
-    configuration files, the library can be disabled by setting
-    ``CONFIG_RTE_LIBRTE_PMD_BOND=n`` and recompiling the DPDK.
+    configuration, the library can be disabled using the meson option
+    "-Ddisable_drivers=net/bond".
+
 
 Link Bonding Modes Overview
 ---------------------------
@@ -377,7 +378,7 @@ Device names and bonding options must be separated by commas as shown below:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..'
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,bond_opt0=..,bond opt1=..'--vdev 'net_bonding1,bond _opt0=..,bond_opt1=..'
 
 Link Bonding EAL Options
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -477,22 +478,22 @@ Create a bonded device in round robin mode with two slaves specified by their PC
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00' -- --port-topology=chained
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00' -- --port-topology=chained
 
 Create a bonded device in round robin mode with two slaves specified by their PCI address and an overriding MAC address:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=0,slave=0000:0a:00.01,slave=0000:04:00.00,mac=00:1e:67:1d:fd:1d' -- --port-topology=chained
 
 Create a bonded device in active backup mode with two slaves specified, and a primary slave specified by their PCI addresses:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,slave=0000:0a:00.01,slave=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=1,slave=0000:0a:00.01,slave=0000:04:00.00,primary=0000:0a:00.01' -- --port-topology=chained
 
 Create a bonded device in balance mode with two slaves specified by their PCI addresses, and a transmission policy of layer 3 + 4 forwarding:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,slave=0000:0a:00.01,slave=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev 'net_bonding0,mode=2,slave=0000:0a:00.01,slave=0000:04:00.00,xmit_policy=l34' -- --port-topology=chained
doc/guides/prog_guide/lto.rst +1 -11
index 277a6f1090..f79c449598 100644
@@ -26,17 +26,7 @@ need to explicitly initialize variable in order to silence the compiler.
 Please note that turning LTO on causes considerable extension of
 build time.
 
-When using make based build, link time optimization can be enabled for
-the whole DPDK by setting:
-
-.. code-block:: console
-
-    CONFIG_RTE_ENABLE_LTO=y
-
-in config file.
-
-For the meson based build it can be enabled by setting meson built-in
-'b_lto' option:
+Link time optimization can be enabled by setting meson built-in 'b_lto' option:
 
 .. code-block:: console
 
doc/guides/prog_guide/mbuf_lib.rst +2 -2
index c3dbfb9221..2f190b40e4 100644
@@ -266,8 +266,8 @@ can be found in several of the sample applications, for example, the IPv4 Multic
 Debug
 -----
 
-In debug mode (CONFIG_RTE_MBUF_DEBUG is enabled),
-the functions of the mbuf library perform sanity checks before any operation (such as, buffer corruption, bad type, and so on).
+In debug mode, the functions of the mbuf library perform sanity checks before any operation (such as, buffer corruption,
+bad type, and so on).
 
 Use Cases
 ---------
doc/guides/prog_guide/mempool_lib.rst +3 -4
index e3e1f940be..f0bdcd3be1 100644
@@ -17,14 +17,13 @@ This library is used by the :ref:`Mbuf Library <Mbuf_Library>`.
 Cookies
 -------
 
-In debug mode (CONFIG_RTE_LIBRTE_MEMPOOL_DEBUG is enabled), cookies are added at the beginning and end of allocated blocks.
+In debug mode, cookies are added at the beginning and end of allocated blocks.
 The allocated objects then contain overwrite protection fields to help debugging buffer overflows.
 
 Stats
 -----
 
-In debug mode (CONFIG_RTE_LIBRTE_MEMPOOL_DEBUG is enabled),
-statistics about get from/put in the pool are stored in the mempool structure.
+In debug mode, statistics about get from/put in the pool are stored in the mempool structure.
 Statistics are per-lcore to avoid concurrent access to statistics counters.
 
 Memory Alignment Constraints on x86 architecture
@@ -90,7 +89,7 @@ the speed at which a core can access its own cache for a specific memory pool wi
 The cache is composed of a small, per-core table of pointers and its length (used as a stack).
 This internal cache can be enabled or disabled at creation of the pool.
 
-The maximum size of the cache is static and is defined at compilation time (CONFIG_RTE_MEMPOOL_CACHE_MAX_SIZE).
+The maximum size of the cache is static and is defined at compilation time (RTE_MEMPOOL_CACHE_MAX_SIZE).
 
 :numref:`figure_mempool` shows a cache in operation.
 
doc/guides/prog_guide/profile_app.rst +3 -14
index e5d0e9079e..7093681983 100644
@@ -33,14 +33,6 @@ Refer to the
 for details about application profiling.
 
 
-Profiling with VTune
-~~~~~~~~~~~~~~~~~~~~
-
-To allow VTune attaching to the DPDK application, reconfigure and recompile
-the DPDK with ``CONFIG_RTE_ETHDEV_RXTX_CALLBACKS`` and
-``CONFIG_RTE_ETHDEV_PROFILE_WITH_VTUNE`` enabled.
-
-
 Profiling on ARM64
 ------------------
 
@@ -76,8 +68,7 @@ cycle counter for user space access by configuring the PMU from the privileged
 mode (kernel space).
 
 By default the ``rte_rdtsc()`` implementation uses a portable ``cntvct_el0``
-scheme.  Application can choose the PMU based implementation with
-``CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU``.
+scheme.
 
 The example below shows the steps to configure the PMU based cycle counter on
 an ARMv8 machine.
@@ -88,10 +79,8 @@ an ARMv8 machine.
     cd armv8_pmu_cycle_counter_el0
     make
     sudo insmod pmu_el0_cycle_counter.ko
-    cd $DPDK_DIR
-    make config T=arm64-armv8a-linux-gcc
-    echo "CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU=y" >> build/.config
-    make
+
+Please refer to :doc:`../linux_gsg/build_dpdk` for details on compiling DPDK with meson.
 
 .. warning::
 
doc/guides/prog_guide/qos_framework.rst +1 -9
index a159709450..4e4ea33ccb 100644
@@ -1525,15 +1525,7 @@ Integration with the DPDK QoS Scheduler
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 RED functionality in the DPDK QoS scheduler is disabled by default.
-To enable it, use the DPDK configuration parameter:
-
-::
-
-    CONFIG_RTE_SCHED_RED=y
-
-This parameter must be set to y.
-The parameter is found in the build configuration files in the DPDK/config directory,
-for example, DPDK/config/common_linux.
+The parameter is found in the build configuration files in the DPDK/config directory.
 RED configuration parameters are specified in the rte_red_params structure within the rte_sched_port_params structure
 that is passed to the scheduler on initialization.
 RED parameters are specified separately for four traffic classes and three packet colors (green, yellow and red)
doc/guides/prog_guide/rcu_lib.rst +3 -4
index d142d0c79d..d0aef3bc16 100644
@@ -186,10 +186,9 @@ they entered a quiescent state. This API checks if a writer has triggered a
 quiescent state query and update the state accordingly.
 
 The ``rte_rcu_qsbr_lock()`` and ``rte_rcu_qsbr_unlock()`` are empty functions.
-However, when ``CONFIG_RTE_LIBRTE_RCU_DEBUG`` is enabled, these APIs aid
-in debugging issues. One can mark the access to shared data structures on the
-reader side using these APIs. The ``rte_rcu_qsbr_quiescent()`` will check if
-all the locks are unlocked.
+However, these APIs can aid in debugging issues. One can mark the access to
+shared data structures on the reader side using these APIs. The
+``rte_rcu_qsbr_quiescent()`` will check if all the locks are unlocked.
 
 Resource reclamation framework for DPDK
 ---------------------------------------
doc/guides/prog_guide/trace_lib.rst +1 -2
index 9bbfd165d8..fbadf9fde9 100644
@@ -135,8 +135,7 @@ In order to avoid performance impact in fast path code, the library introduced
 the user must use ``RTE_TRACE_POINT_FP`` instead of ``RTE_TRACE_POINT``.
 
 ``RTE_TRACE_POINT_FP`` is compiled out by default and it can be enabled using
-``CONFIG_RTE_ENABLE_TRACE_FP`` configuration parameter.
-The ``enable_trace_fp`` option shall be used for the same for meson build.
+the ``enable_trace_fp`` option for meson build.
 
 Event record mode
 -----------------
doc/guides/prog_guide/writing_efficient_code.rst +1 -2
index 2639ef7bf6..db2f1ddbc2 100644
@@ -258,8 +258,7 @@ For instance:
 Setting the Target CPU Type
 ---------------------------
 
-The DPDK supports CPU microarchitecture-specific optimizations by means of CONFIG_RTE_MACHINE option
-in the DPDK configuration file.
+The DPDK supports CPU microarchitecture-specific optimizations by means of RTE_MACHINE option.
 The degree of optimization depends on the compiler's ability to optimize for a specific microarchitecture,
 therefore it is preferable to use the latest compiler versions whenever possible.
 
Signature · 1 line
2.17.1
Reviewed-by on v5 6/20
#226 lore raw

Re: [dpdk-dev] [PATCH v5 06/20] doc: remove references to make from prog guide

Quoted 5 lines · Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

Quoted 16 lines
---
  doc/guides/prog_guide/env_abstraction_layer.rst | 17 ++++++-----------
  doc/guides/prog_guide/graph_lib.rst             |  6 ++----
  .../prog_guide/ip_fragment_reassembly_lib.rst   |  5 -----
  doc/guides/prog_guide/kernel_nic_interface.rst  | 14 +++++++-------
  .../link_bonding_poll_mode_drv_lib.rst          | 15 ++++++++-------
  doc/guides/prog_guide/lto.rst                   | 12 +-----------
  doc/guides/prog_guide/mbuf_lib.rst              |  4 ++--
  doc/guides/prog_guide/mempool_lib.rst           |  7 +++----
  doc/guides/prog_guide/profile_app.rst           | 17 +++--------------
  doc/guides/prog_guide/qos_framework.rst         | 10 +---------
  doc/guides/prog_guide/rcu_lib.rst               |  7 +++----
  doc/guides/prog_guide/trace_lib.rst             |  3 +--
  .../prog_guide/writing_efficient_code.rst       |  3 +--
  13 files changed, 38 insertions(+), 82 deletions(-)

For kernel_nic_interface.rst,

#227 lore raw

Re: [dpdk-dev] [PATCH v5 06/20] doc: remove references to make from prog guide

Quoted 23 lines · Ferruh Yigit
Quoted 19 lines · Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
  doc/guides/prog_guide/env_abstraction_layer.rst | 17 ++++++----------- doc/guides/prog_guide/graph_lib.rst             |  6 ++---- .../prog_guide/ip_fragment_reassembly_lib.rst   |  5 ----- doc/guides/prog_guide/kernel_nic_interface.rst  | 14 +++++++------- .../link_bonding_poll_mode_drv_lib.rst          | 15 ++++++++------- doc/guides/prog_guide/lto.rst                   | 12 +----------- doc/guides/prog_guide/mbuf_lib.rst              |  4 ++-- doc/guides/prog_guide/mempool_lib.rst           |  7 +++---- doc/guides/prog_guide/profile_app.rst           | 17 +++-------------- doc/guides/prog_guide/qos_framework.rst         | 10 +--------- doc/guides/prog_guide/rcu_lib.rst               |  7 +++---- doc/guides/prog_guide/trace_lib.rst             |  3 +-- .../prog_guide/writing_efficient_code.rst       |  3 +--

Quoted 2 lines
  13 files changed, 38 insertions(+), 82 deletions(-)
Quoted 3 lines

For kernel_nic_interface.rst,

Ahh, I acked the wrong version, I will carry them to v6

#228 lore raw

PATCH v5 7/20 doc: remove references to make from platforms guides

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/platform/bluefield.rst | 22 ---------------------
 doc/guides/platform/octeontx.rst  | 33 +------------------------------
 doc/guides/platform/octeontx2.rst | 32 ------------------------------
 3 files changed, 1 insertion(+), 86 deletions(-)
doc/guides/platform/bluefield.rst +0 -22
index deda675b75..366f2b23a7 100644
@@ -60,17 +60,6 @@ Native Compilation
 Refer to :doc:`../nics/mlx5` for prerequisites. Either Mellanox OFED/EN or
 rdma-core library with corresponding kernel drivers is required.
 
-make build
-^^^^^^^^^^
-
-.. code-block:: console
-
-        make config T=arm64-bluefield-linux-gcc
-        make -j
-
-meson build
-^^^^^^^^^^^
-
 .. code-block:: console
 
         meson build
@@ -126,17 +115,6 @@ Then, untar the tarball at the cross toolchain directory on the x86 host.
         cd $(dirname $(which aarch64-linux-gnu-gcc))/..
         tar xf aarch64-linux-gnu-mlx.tar
 
-make build
-^^^^^^^^^^
-
-.. code-block:: console
-
-        make config T=arm64-bluefield-linux-gcc
-        make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n
-
-meson build
-^^^^^^^^^^^
-
 .. code-block:: console
 
         meson build --cross-file config/arm/arm64_bluefield_linux_gcc
doc/guides/platform/octeontx.rst +1 -32
index 7d1cb647d3..9c20ce437d 100644
@@ -90,23 +90,8 @@ native architecture, the linux sources need to be compiled once natively.
 
 The above steps would rebuild the modules and the required intermediate binaries.
 Once the target is ready for native compilation, the OCTEON TX platform
-drivers can be compiled with the following steps,
+drivers can be compiled, see :doc:`../linux_gsg/build_dpdk` for details.
 
-.. code-block:: console
-
-        cd <dpdk directory>
-        make config T=arm64-thunderx-linux-gcc
-        make
-
-The example applications can be compiled using the following:
-
-.. code-block:: console
-
-        cd <dpdk directory>
-        export RTE_SDK=$PWD
-        export RTE_TARGET=build
-        cd examples/<application>
-        make
 
 Cross Compilation
 ~~~~~~~~~~~~~~~~~
@@ -139,23 +124,7 @@ SDK 6.2.0 patch 3:
 The above steps will prepare build system with numa additions. Now this build system can be used
 to build applications for **OCTEON TX** :sup:`®` platforms.
 
-.. code-block:: console
-
-        cd <dpdk directory>
-        export RTE_SDK=$PWD
-        export RTE_KERNELDIR=$THUNDER_ROOT/linux/kernel/linux
-        make config T=arm64-thunderx-linux-gcc
-        make -j CROSS=aarch64-thunderx-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n EXTRA_CFLAGS="-isystem <numa_install_dir>/include" EXTRA_LDFLAGS="-L<numa_install_dir>/lib -lnuma"
-
 If NUMA support is not required, it can be disabled as explained in
 :doc:`../linux_gsg/cross_build_dpdk_for_arm64`.
 
-Following steps could be used in that case.
-
-.. code-block:: console
-
-        make config T=arm64-thunderx-linux-gcc
-        make CROSS=aarch64-thunderx-linux-gnu-
-
-
 SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.
doc/guides/platform/octeontx2.rst +0 -32
index 13255eec5c..232f628366 100644
@@ -498,27 +498,6 @@ an x86 based platform.
 Native Compilation
 ~~~~~~~~~~~~~~~~~~
 
-make build
-^^^^^^^^^^
-
-.. code-block:: console
-
-        make config T=arm64-octeontx2-linux-gcc
-        make -j
-
-The example applications can be compiled using the following:
-
-.. code-block:: console
-
-        cd <dpdk directory>
-        export RTE_SDK=$PWD
-        export RTE_TARGET=build
-        cd examples/<application>
-        make -j
-
-meson build
-^^^^^^^^^^^
-
 .. code-block:: console
 
         meson build
@@ -529,17 +508,6 @@ Cross Compilation
 
 Refer to :doc:`../linux_gsg/cross_build_dpdk_for_arm64` for generic arm64 details.
 
-make build
-^^^^^^^^^^
-
-.. code-block:: console
-
-        make config T=arm64-octeontx2-linux-gcc
-        make -j CROSS=aarch64-marvell-linux-gnu- CONFIG_RTE_KNI_KMOD=n
-
-meson build
-^^^^^^^^^^^
-
 .. code-block:: console
 
         meson build --cross-file config/arm/arm64_octeontx2_linux_gcc
Signature · 1 line
2.17.1
#229 lore raw

PATCH v5 8/20 doc: remove references to make from mempool guide

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/mempool/octeontx.rst  | 28 +++-------------------------
 doc/guides/mempool/octeontx2.rst | 10 +---------
 2 files changed, 4 insertions(+), 34 deletions(-)
doc/guides/mempool/octeontx.rst +3 -25
index dfa1993e19..33c40d5b17 100644
@@ -30,33 +30,11 @@ Prerequisites
 
 See :doc: `../platform/octeontx.rst` for setup information.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``)
-
-  Set default mempool ops to octeontx_fpavf.
-
-- ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL`` (default ``y``)
-
-  Toggle compilation of the ``librte_mempool_octeontx`` driver.
 
 Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the OCTEON TX FPAVF MEMPOOL PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
+------------------
 
-   cd <DPDK-source-directory>
-   make config T=arm64-thunderx-linux-gcc
+See :doc:`../linux_gsg/build_dpdk` for more information on compiling DPDK.
 
 
 Initialization
@@ -70,5 +48,5 @@ Example:
 
 .. code-block:: console
 
-    ./build/app/test -c 0xf --base-virtaddr=0x100000000000 \
+    ./<build_dir>/app/test/dpdk-test -c 0xf --base-virtaddr=0x100000000000 \
                         --mbuf-pool-ops-name="octeontx_fpavf"
doc/guides/mempool/octeontx2.rst +1 -9
index 49b45a04e8..53f09a52db 100644
@@ -29,14 +29,6 @@ Prerequisites and Compilation procedure
 Pre-Installation Configuration
 ------------------------------
 
-Compile time Config Options
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following option can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL`` (default ``y``)
-
-  Toggle compilation of the ``librte_mempool_octeontx2`` driver.
 
 Runtime Config Options
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -97,4 +89,4 @@ Standalone mempool device
 
    Example command to run ``mempool_autotest`` test with standalone OCTEONTX2 NPA device::
 
-     echo "mempool_autotest" | build/app/test -c 0xf0 --mbuf-pool-ops-name="octeontx2_npa"
+     echo "mempool_autotest" | <build_dir>/app/test/dpdk-test -c 0xf0 --mbuf-pool-ops-name="octeontx2_npa"
Signature · 1 line
2.17.1
#230 lore raw

PATCH v5 9/20 doc: remove references to make from NICs guides

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/nics/ark.rst            | 26 -------------
 doc/guides/nics/atlantic.rst       |  4 --
 doc/guides/nics/axgbe.rst          | 15 --------
 doc/guides/nics/bnx2x.rst          | 27 -------------
 doc/guides/nics/bnxt.rst           |  5 +--
 doc/guides/nics/build_and_test.rst |  8 +++-
 doc/guides/nics/cxgbe.rst          | 36 +++++------------
 doc/guides/nics/dpaa.rst           | 27 +------------
 doc/guides/nics/dpaa2.rst          | 26 +------------
 doc/guides/nics/ena.rst            | 16 --------
 doc/guides/nics/enetc.rst          |  2 -
 doc/guides/nics/enic.rst           |  9 -----
 doc/guides/nics/fail_safe.rst      | 20 ++--------
 doc/guides/nics/features.rst       |  9 -----
 doc/guides/nics/fm10k.rst          |  4 --
 doc/guides/nics/hinic.rst          |  9 -----
 doc/guides/nics/hns3.rst           | 10 -----
 doc/guides/nics/i40e.rst           | 44 ++++++---------------
 doc/guides/nics/ice.rst            | 25 ++----------
 doc/guides/nics/igc.rst            | 18 +--------
 doc/guides/nics/intel_vf.rst       | 13 +------
 doc/guides/nics/ionic.rst          |  8 ----
 doc/guides/nics/ipn3ke.rst         | 12 +-----
 doc/guides/nics/kni.rst            |  4 +-
 doc/guides/nics/liquidio.rst       | 27 -------------
 doc/guides/nics/memif.rst          | 10 ++---
 doc/guides/nics/mlx4.rst           | 55 ++------------------------
 doc/guides/nics/mlx5.rst           | 62 ++----------------------------
 doc/guides/nics/mvneta.rst         | 36 ++++-------------
 doc/guides/nics/mvpp2.rst          | 43 ++++-----------------
 doc/guides/nics/nfb.rst            | 19 +--------
 doc/guides/nics/nfp.rst            |  4 --
 doc/guides/nics/null.rst           |  6 +--
 doc/guides/nics/octeontx.rst       | 19 +--------
 doc/guides/nics/octeontx2.rst      | 13 +------
 doc/guides/nics/pcap_ring.rst      | 24 ++++++------
 doc/guides/nics/qede.rst           | 17 +-------
 doc/guides/nics/sfc_efx.rst        | 15 --------
 doc/guides/nics/softnic.rst        | 13 +------
 doc/guides/nics/szedata2.rst       | 18 +--------
 doc/guides/nics/thunderx.rst       | 25 +-----------
 doc/guides/nics/vdev_netvsc.rst    |  6 ---
 doc/guides/nics/vhost.rst          |  2 +-
 doc/guides/nics/virtio.rst         |  4 +-
 44 files changed, 102 insertions(+), 693 deletions(-)
doc/guides/nics/ark.rst +0 -26
index 06e8c33746..d7d679b452 100644
@@ -119,32 +119,6 @@ Data Path Interface
 Ingress RX and Egress TX operation is by the nominal DPDK API .
 The driver supports single-port, multi-queue for both RX and TX.
 
-Configuration Information
--------------------------
-
-**DPDK Configuration Parameters**
-
-  The following configuration options are available for the ARK PMD:
-
-   * **CONFIG_RTE_LIBRTE_ARK_PMD** (default y): Enables or disables inclusion
-     of the ARK PMD driver in the DPDK compilation.
-
-   * **CONFIG_RTE_LIBRTE_ARK_PAD_TX** (default y):  When enabled TX
-     packets are padded to 60 bytes to support downstream MACS.
-
-   * **CONFIG_RTE_LIBRTE_ARK_DEBUG_RX** (default n): Enables or disables debug
-     logging and internal checking of RX ingress logic within the ARK PMD driver.
-
-   * **CONFIG_RTE_LIBRTE_ARK_DEBUG_TX** (default n): Enables or disables debug
-     logging and internal checking of TX egress logic within the ARK PMD driver.
-
-   * **CONFIG_RTE_LIBRTE_ARK_DEBUG_STATS** (default n): Enables or disables debug
-     logging of detailed packet and performance statistics gathered in
-     the PMD and FPGA.
-
-   * **CONFIG_RTE_LIBRTE_ARK_DEBUG_TRACE** (default n): Enables or disables debug
-     logging of detailed PMD events and status.
-
 
 Building DPDK
 -------------
doc/guides/nics/atlantic.rst +0 -4
index 3f3f2949f3..605f6dc3ab 100644
@@ -26,10 +26,6 @@ Experimental API features
 
 - MACSEC PMD API is considered as experimental and is subject to change/removal in next DPDK releases.
 
-Configuration Information
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- ``CONFIG_RTE_LIBRTE_ATLANTIC_PMD`` (default ``y``)
 
 Application Programming Interface
 ---------------------------------
doc/guides/nics/axgbe.rst +0 -15
index 9b270a4226..10bf86fa54 100644
@@ -27,21 +27,6 @@ AXGBE PMD has support for:
 - Jumbo Frame up to 9K
 
 
-Configuration Information
--------------------------
-
-The following options can be modified in the ``.config`` file. Please note that
-enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_AXGBE_PMD`` (default **y**)
-
-  Toggle compilation of axgbe PMD.
-
-- ``CONFIG_RTE_LIBRTE_AXGBE_PMD_DEBUG`` (default **n**)
-
-  Toggle display for PMD debug related messages.
-
-
 Building DPDK
 -------------
 
doc/guides/nics/bnx2x.rst +0 -27
index ab90d8ae5e..3c163df7a8 100644
@@ -72,33 +72,6 @@ Prerequisites
   `linux-firmware git repository <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/plain/bnx2x/bnx2x-e2-7.13.11.0.fw>`_
   to get the required firmware.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``.config`` file. Please note that
-enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **n**)
-
-  Toggle compilation of bnx2x driver. To use bnx2x PMD set this config parameter
-  to 'y'. Also, in order for firmware binary to load user will need zlib devel
-  package installed.
-
-- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **n**)
-
-  Toggle display of transmit fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **n**)
-
-  Toggle display of receive fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **n**)
-
-  Toggle display of register reads and writes.
-
 
 .. _bnx2x_driver-compilation:
 
doc/guides/nics/bnxt.rst +1 -4
index 129a16cfc7..4b172fdaac 100644
@@ -565,9 +565,6 @@ The BNXT PMD supports a PTP client application to communicate with a PTP master
 clock using DPDK IEEE1588 APIs. Note that the PTP client application needs to
 run on PF and vector mode needs to be disabled.
 
-For the PTP time synchronization support, the BNXT PMD must be compiled with
-``CONFIG_RTE_LIBRTE_IEEE1588=y`` (this compilation flag is currently pending).
-
 .. code-block:: console
 
     testpmd> set fwd ieee1588 // enable IEEE 1588 mode
@@ -612,7 +609,7 @@ Basic stats include:
 * oerrors
 
 By default, per-queue stats for 16 queues are supported. For more than 16
-queues, BNXT PMD should be compiled with ``CONFIG_RTE_ETHDEV_QUEUE_STAT_CNTRS``
+queues, BNXT PMD should be compiled with ``RTE_ETHDEV_QUEUE_STAT_CNTRS``
 set to the desired number of queues.
 
 Extended Stats
doc/guides/nics/build_and_test.rst +6 -2
index 3138c0f880..03ce358553 100644
@@ -66,10 +66,14 @@ This section demonstrates how to setup and run ``testpmd`` in Linux.
 
 #. Load ``igb_uio`` or ``vfio-pci`` driver:
 
+   Before compiling, make sure to enable kmods for the meson build::
+
+      meson configure -Denable_kmods=true
+
    .. code-block:: console
 
       modprobe uio
-      insmod ./x86_64-native-linux-gcc/kmod/igb_uio.ko
+      insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
 
    or
 
@@ -106,7 +110,7 @@ This section demonstrates how to setup and run ``testpmd`` in Linux.
 
    .. code-block:: console
 
-      ./x86_64-native-linux-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
doc/guides/nics/cxgbe.rst +10 -26
index 54a4c13899..442ab1511c 100644
@@ -87,35 +87,19 @@ Prerequisites
   :ref:`linux-installation` for Linux and section :ref:`freebsd-installation`
   for FreeBSD.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``.config`` file. Please note that
-enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_CXGBE_PMD`` (default **y**)
-
-  Toggle compilation of librte_pmd_cxgbe driver.
-
-  .. note::
-
-     This controls compilation of both CXGBE and CXGBEVF PMD.
 
 Runtime Options
-~~~~~~~~~~~~~~~
+---------------
 
 The following ``devargs`` options can be enabled at runtime. They must
 be passed as part of EAL arguments. For example,
 
 .. code-block:: console
 
-   testpmd -w 02:00.4,keep_ovlan=1 -- -i
+   dpdk-testpmd -w 02:00.4,keep_ovlan=1 -- -i
 
 Common Runtime Options
-^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~
 
 - ``keep_ovlan`` (default **0**)
 
@@ -133,7 +117,7 @@ Common Runtime Options
   coalesce limit has been reached.
 
 CXGBE VF Only Runtime Options
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - ``force_link_up`` (default **0**)
 
@@ -142,7 +126,7 @@ CXGBE VF Only Runtime Options
   to send traffic to each other even when the physical link is down.
 
 CXGBE PF Only Runtime Options
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - ``filtermode`` (default **0**)
 
@@ -317,7 +301,7 @@ CXGBE PF Only Runtime Options
 
   .. code-block:: console
 
-     testpmd -w 02:00.4,filtermode=0x88 -- -i
+     dpdk-testpmd -w 02:00.4,filtermode=0x88 -- -i
 
 - ``filtermask`` (default **0**)
 
@@ -344,7 +328,7 @@ CXGBE PF Only Runtime Options
 
   .. code-block:: console
 
-     testpmd -w 02:00.4,filtermode=0x88,filtermask=0x80 -- -i
+     dpdk-testpmd -w 02:00.4,filtermode=0x88,filtermask=0x80 -- -i
 
 .. _driver-compilation:
 
@@ -689,7 +673,7 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system.
 
    .. code-block:: console
 
-      cp x86_64-native-freebsd-clang/kmod/contigmem.ko /boot/kernel/
+      cp <build_dir>/kernel/freebsd/contigmem.ko /boot/kernel/
 
 #. Add the following lines to /boot/loader.conf:
 
@@ -770,13 +754,13 @@ devices managed by librte_pmd_cxgbe in FreeBSD operating system.
 
    .. code-block:: console
 
-      kldload ./x86_64-native-freebsd-clang/kmod/nic_uio.ko
+      kldload <build_dir>/kernel/freebsd/nic_uio.ko
 
 #. Start testpmd with basic parameters:
 
    .. code-block:: console
 
-      ./x86_64-native-freebsd-clang/app/testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i
+      ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0000:02:00.4 -- -i
 
    Example output:
 
doc/guides/nics/dpaa.rst +1 -26
index 17839a920e..eba8bfe600 100644
@@ -195,31 +195,6 @@ See :doc:`../platform/dpaa` for setup information
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_DPAA_BUS`` (default ``y``)
-
-  Toggle compilation of the ``librte_bus_dpaa`` driver.
-
-- ``CONFIG_RTE_LIBRTE_DPAA_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_dpaa`` driver.
-
-- ``CONFIG_RTE_LIBRTE_DPAA_DEBUG_DRIVER`` (default ``n``)
-
-  Toggles display of bus configurations and enables a debugging queue
-  to fetch error (Rx/Tx) packets to driver. By default, packets with errors
-  (like wrong checksum) are dropped by the hardware.
-
-- ``CONFIG_RTE_LIBRTE_DPAA_HWDEBUG`` (default ``n``)
-
-  Enables debugging of the Queue and Buffer Manager layer which interacts
-  with the DPAA hardware.
-
 
 Environment Variables
 ~~~~~~~~~~~~~~~~~~~~~
@@ -264,7 +239,7 @@ for details.
 
    .. code-block:: console
 
-      ./arm64-dpaa-linux-gcc/testpmd -c 0xff -n 1 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 1 \
         -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx
 
       .....
doc/guides/nics/dpaa2.rst +1 -25
index fdfa6fdd5a..b64bc6311b 100644
@@ -432,30 +432,6 @@ Currently supported by DPDK:
    Some part of fslmc bus code (mc flib - object library) routines are
    dual licensed (BSD & GPLv2), however they are used as BSD in DPDK in userspace.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_FSLMC_BUS`` (default ``y``)
-
-  Toggle compilation of the ``librte_bus_fslmc`` driver.
-
-- ``CONFIG_RTE_LIBRTE_DPAA2_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_dpaa2`` driver.
-
-- ``CONFIG_RTE_LIBRTE_DPAA2_DEBUG_DRIVER`` (default ``n``)
-
-  Toggle display of debugging messages/logic
-
-- ``CONFIG_RTE_LIBRTE_DPAA2_USE_PHYS_IOVA`` (default ``n``)
-
-  Toggle to use physical address vs virtual address for hardware accelerators.
 
 Driver compilation and testing
 ------------------------------
@@ -473,7 +449,7 @@ for details.
 
    .. code-block:: console
 
-      ./testpmd -c 0xff -n 1 -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx
+      ./dpdk-testpmd -c 0xff -n 1 -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx
 
       .....
       EAL: Registered [pci] bus.
doc/guides/nics/ena.rst +0 -16
index bec97c3326..4bdc3182fc 100644
@@ -79,22 +79,6 @@ The driver supports multi-queue for both Tx and Rx.
 Configuration information
 -------------------------
 
-**DPDK Configuration Parameters**
-
-  The following configuration options are available for the ENA PMD:
-
-   * **CONFIG_RTE_LIBRTE_ENA_PMD** (default y): Enables or disables inclusion
-     of the ENA PMD driver in the DPDK compilation.
-
-   * **CONFIG_RTE_LIBRTE_ENA_DEBUG_RX** (default n): Enables or disables debug
-     logging of RX logic within the ENA PMD driver.
-
-   * **CONFIG_RTE_LIBRTE_ENA_DEBUG_TX** (default n): Enables or disables debug
-     logging of TX logic within the ENA PMD driver.
-
-   * **CONFIG_RTE_LIBRTE_ENA_COM_DEBUG** (default n): Enables or disables debug
-     logging of low level tx/rx logic in ena_com(base) within the ENA PMD driver.
-
 **Runtime Configuration Parameters**
 
    * **large_llq_hdr** (default 0)
doc/guides/nics/enetc.rst +0 -2
index 3c896eeffa..6203f4d799 100644
@@ -113,5 +113,3 @@ Driver compilation and testing
 Follow instructions available in the document
 :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 to launch **testpmd**
-
-To compile in performance mode, please set ``CONFIG_RTE_CACHE_LINE_SIZE=64``
doc/guides/nics/enic.rst +0 -9
index a28a7f4e47..be6a034279 100644
@@ -20,13 +20,6 @@ should be downloaded from https://core.dpdk.org/download/
 Configuration information
 -------------------------
 
-- **DPDK Configuration Parameters**
-
-  The following configuration options are available for the ENIC PMD:
-
-  - **CONFIG_RTE_LIBRTE_ENIC_PMD** (default y): Enables or disables inclusion
-    of the ENIC PMD driver in the DPDK compilation.
-
 - **vNIC Configuration Parameters**
 
   - **Number of Queues**
@@ -583,8 +576,6 @@ The value depends on the memory configuration of the application, DPDK and
 PMD.  Typically, the limit has to be raised to higher than 2GB.
 e.g., 2621440
 
-The compilation of any unused drivers can be disabled using the
-configuration file in config/ directory (e.g., config/common_linux).
 This would help in bringing down the time taken for building the
 libraries and the initialization time of the application.
 
doc/guides/nics/fail_safe.rst +4 -16
index b4a92f663b..b7bc5a566b 100644
@@ -14,10 +14,6 @@ Additionally to the Seamless Hotplug feature, the Fail-safe PMD offers the
 ability to redirect operations to a secondary device when the primary has been
 removed from the system.
 
-.. note::
-
-   The library is enabled by default. You can enable it or disable it manually
-   by setting the ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` configuration option.
 
 Features
 --------
@@ -33,14 +29,6 @@ automatically by detecting capable devices and registering the relevant handler.
 
 Check the feature matrix for the complete set of supported features.
 
-Compilation option
-------------------
-
-Available options within the ``$RTE_TARGET/build/.config`` file:
-
-- ``CONFIG_RTE_LIBRTE_PMD_FAILSAFE`` (default **y**)
-
-  This option enables or disables compiling librte_pmd_failsafe.
 
 Using the Fail-safe PMD from the EAL command line
 -------------------------------------------------
@@ -128,7 +116,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
 
    .. code-block:: console
 
-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \
          --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
          -b 84:00.0 -b 00:04.0 -- -i
 
@@ -142,7 +130,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
 
    .. code-block:: console
 
-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \
          --vdev 'net_failsafe0,mac=de:ad:be:ef:01:02,dev(84:00.0),dev(net_ring0)' \
          -w 81:00.0 -- -i
 
@@ -150,7 +138,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
 
    .. code-block:: console
 
-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 -w ff:ff.f \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 -w ff:ff.f \
          --vdev='net_failsafe0,exec(echo 84:00.0)' -- -i
 
 #. Start testpmd, automatically probing the device 84:00.0 and using it with
@@ -158,7 +146,7 @@ This section shows some example of using **testpmd** with a fail-safe PMD.
  
    .. code-block:: console
  
-      $RTE_TARGET/build/app/testpmd -c 0xff -n 4 \
+      ./<build_dir>/app/dpdk-testpmd -c 0xff -n 4 \
          --vdev 'net_failsafe0,dev(0000:84:00.0),dev(net_ring0)' -- -i
 
 
doc/guides/nics/features.rst +0 -9
index edd21c4d8e..6172a0fa4b 100644
@@ -812,8 +812,6 @@ ARMv7
 
 Support armv7 architecture.
 
-Use ``defconfig_arm-armv7a-*-*``.
-
 
 .. _nic_features_armv8:
 
@@ -822,8 +820,6 @@ ARMv8
 
 Support armv8a (64bit) architecture.
 
-Use ``defconfig_arm64-armv8a-*-*``
-
 
 .. _nic_features_power8:
 
@@ -832,7 +828,6 @@ Power8
 
 Support PowerPC architecture.
 
-Use ``defconfig_ppc_64-power8-*-*``
 
 .. _nic_features_x86-32:
 
@@ -841,8 +836,6 @@ x86-32
 
 Support 32bits x86 architecture.
 
-Use ``defconfig_x86_x32-native-*-*`` and ``defconfig_i686-native-*-*``.
-
 
 .. _nic_features_x86-64:
 
@@ -851,8 +844,6 @@ x86-64
 
 Support 64bits x86 architecture.
 
-Use ``defconfig_x86_64-native-*-*``.
-
 
 .. _nic_features_usage_doc:
 
doc/guides/nics/fm10k.rst +0 -4
index 4e178c2cc6..0f7c91bbd1 100644
@@ -35,10 +35,6 @@ There is no change to the PMD API. The RX/TX handlers are the only two entries f
 vPMD packet I/O. They are transparently registered at runtime RX/TX execution
 if all required conditions are met.
 
-1.  To date, only an SSE version of FM10K vPMD is available.
-    To ensure that vPMD is in the binary code, set
-    ``CONFIG_RTE_LIBRTE_FM10K_INC_VECTOR=y`` in the configure file.
-
 Some constraints apply as pre-conditions for specific optimizations on bulk
 packet transfers. The following sections explain RX and TX constraints in the
 vPMD.
doc/guides/nics/hinic.rst +0 -9
index f765060641..fe13c582e7 100644
@@ -46,15 +46,6 @@ Prerequisites
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_HINIC_PMD`` (default ``y``)
 
 Driver compilation and testing
 ------------------------------
doc/guides/nics/hns3.rst +0 -10
index a62fcfdede..d96ad5d445 100644
@@ -44,16 +44,6 @@ Prerequisites
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_HNS3_PMD`` (default ``y``)
 
 Driver compilation and testing
 ------------------------------
doc/guides/nics/i40e.rst +12 -32

84 lines not on this page · raw message

doc/guides/nics/ice.rst +4 -21
index 9a9f4a6bb0..9d3fcd1c9c 100644
@@ -23,23 +23,6 @@ Prerequisites
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_ICE_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_ice`` driver.
-
-- ``CONFIG_RTE_LIBRTE_ICE_DEBUG_*`` (default ``n``)
-
-  Toggle display of generic debugging messages.
-
-- ``CONFIG_RTE_LIBRTE_ICE_16BYTE_RX_DESC`` (default ``n``)
-
-  Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
 
 Runtime Config Options
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -106,14 +89,14 @@ Runtime Config Options
 
   .. code-block:: console
 
-    testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
+    dpdk-testpmd -w 18:00.0,proto_xtr='[(1,2-3,8-9):tcp,10-13:vlan]'
 
   This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-13 are
   VLAN extraction, other queues run with no protocol extraction.
 
   .. code-block:: console
 
-    testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
+    dpdk-testpmd -w 18:00.0,proto_xtr=vlan,proto_xtr='[(1,2-3,8-9):tcp,10-23:ipv6]'
 
   This setting means queues 1, 2-3, 8-9 are TCP extraction, queues 10-23 are
   IPv6 extraction, other queues use the default VLAN extraction.
@@ -253,7 +236,7 @@ responses for the same from PF.
 
 #. Bind the VF0,  and run testpmd with 'cap=dcf' devarg::
 
-      testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i
+      dpdk-testpmd -l 22-25 -n 4 -w 18:01.0,cap=dcf -- -i
 
 #. Monitor the VF2 interface network traffic::
 
@@ -282,7 +265,7 @@ To start ``testpmd``, and add vlan 10 to port 0:
 
 .. code-block:: console
 
-    ./app/testpmd -l 0-15 -n 4 -- -i
+    ./app/dpdk-testpmd -l 0-15 -n 4 -- -i
     ...
 
     testpmd> rx_vlan add 10 0
doc/guides/nics/igc.rst +2 -16
index 4c5e626759..3b096236bf 100644
@@ -11,20 +11,6 @@ I225 Series Network Adapters.
   `https://ark.intel.com/content/www/us/en/ark/products/series/184686/
   intel-ethernet-controller-i225-series.html`
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_IGC_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_igc`` driver.
-
-- ``CONFIG_RTE_LIBRTE_IGC_DEBUG_*`` (default ``n``)
-
-  Toggle display of generic debugging messages.
-
 
 Driver compilation and testing
 ------------------------------
@@ -67,7 +53,7 @@ outer VLAN to 0x9100:
 
 .. code-block:: console
 
-   ./app/testpmd -l 4-8 -- -i
+   ./app/dpdk-testpmd -l 4-8 -- -i
    ...
 
    testpmd> vlan set filter on 0
@@ -94,7 +80,7 @@ Start ``testpmd``:
 
 .. code-block:: console
 
-   ./testpmd -l 4-8 -- i --rxq=4 --txq=4 --pkt-filter-mode=perfect --disable-rss
+   ./dpdk-testpmd -l 4-8 -- i --rxq=4 --txq=4 --pkt-filter-mode=perfect --disable-rss
 
 Add a rule to direct packet whose ``ether-type=0x801`` to queue 1:
 
doc/guides/nics/intel_vf.rst +2 -11
index ade5152595..723a9c0fa2 100644
@@ -124,7 +124,6 @@ Intel® X710/XL710 Gigabit Ethernet Controller VF Infrastructure
 
 In a virtualized environment, the programmer can enable a maximum of *128 Virtual Functions (VF)*
 globally per Intel® X710/XL710 Gigabit Ethernet Controller NIC device.
-The number of queue pairs of each VF can be configured by ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VF`` in ``config`` file.
 The Physical Function in host could be either configured by the Linux* i40e driver
 (in the case of the Linux Kernel-based Virtual Machine [KVM]) or by DPDK PMD PF driver.
 When using both DPDK PMD PF/VF drivers, the whole NIC will be taken over by DPDK based application.
@@ -521,20 +520,12 @@ The setup procedure is as follows:
 
     .. code-block:: console
 
-        make install T=x86_64-native-linux-gcc
-        ./x86_64-native-linux-gcc/app/testpmd -l 0-3 -n 4 -- -i
+        ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -- -i
 
 #.  Finally, access the Guest OS using vncviewer with the localhost:5900 port and check the lspci command output in the Guest OS.
     The virtual functions will be listed as available for use.
 
-#.  Configure and install the DPDK with an x86_64-native-linux-gcc configuration on the Guest OS as normal,
-    that is, there is no change to the normal installation procedure.
-
-    .. code-block:: console
-
-        make config T=x86_64-native-linux-gcc O=x86_64-native-linux-gcc
-        cd x86_64-native-linux-gcc
-        make
+#.  Configure and install the DPDK on the Guest OS as normal, that is, there is no change to the normal installation procedure.
 
 .. note::
 
doc/guides/nics/ionic.rst +0 -8
index 787123df5d..fd32926bf4 100644
@@ -24,14 +24,6 @@ on the host, check for the PCI devices:
       b5:00.0 Ethernet controller: Device 1dd8:1002
       b6:00.0 Ethernet controller: Device 1dd8:1002
 
-Pre-Installation Configuration
-------------------------------
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_IONIC_PMD`` (default ``y``)
-
-  Toggle compilation of ionic PMD.
 
 Building DPDK
 -------------
doc/guides/nics/ipn3ke.rst +2 -10
index c6c1552f66..5d4534e4da 100644
@@ -31,14 +31,6 @@ Prerequisites
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_IPN3KE_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_ipn3ke`` driver.
 
 Runtime Config Options
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -85,7 +77,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port:
 
 .. code-block:: console
 
-    ./app/testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop
+    ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --port-topology=loop
 
 HQoS and flow acceleration
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -96,7 +88,7 @@ To start ``testpmd``, and add I40e PF to FPGA network port, enable FPGA HQoS and
 
 .. code-block:: console
 
-    ./app/testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap
+    ./<build_dir>/app/dpdk-testpmd -l 0-15 -n 4 --vdev 'ifpga_rawdev_cfg0,ifpga=b3:00.0,port=0' --vdev 'ipn3ke_cfg0,afu=0|b3:00.0,fpga_acc={tm|flow},i40e_pf={0000:b1:00.0|0000:b1:00.1|0000:b1:00.2|0000:b1:00.3|0000:b5:00.0|0000:b5:00.1|0000:b5:00.2|0000:b5:00.3}' -- -i --no-numa --forward-mode=macswap
 
 Limitations or Known issues
 ---------------------------
doc/guides/nics/kni.rst +2 -2
index 90d3040cf5..80ba459d49 100644
@@ -97,13 +97,13 @@ It is possible to test PMD quickly using KNI kernel module loopback feature:
 
     .. code-block:: console
 
-        insmod build/kmod/rte_kni.ko lo_mode=lo_mode_fifo_skb
+        insmod <build_dir>/kernel/linux/kni/rte_kni.ko lo_mode=lo_mode_fifo_skb
 
 * Start testpmd with no physical device but two KNI virtual devices:
 
     .. code-block:: console
 
-        ./testpmd --vdev net_kni0 --vdev net_kni1 -- -i
+        ./dpdk-testpmd --vdev net_kni0 --vdev net_kni1 -- -i
 
     .. code-block:: console
 
doc/guides/nics/liquidio.rst +0 -27
index 0534146720..65c7d2d0b0 100644
@@ -20,33 +20,6 @@ Supported LiquidIO Adapters
 - LiquidIO II CN2360 210SVPT
 
 
-Pre-Installation Configuration
-------------------------------
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_LIO_PMD`` (default ``y``)
-
-  Toggle compilation of LiquidIO PMD.
-
-- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_RX`` (default ``n``)
-
-  Toggle display of receive fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_TX`` (default ``n``)
-
-  Toggle display of transmit fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_MBOX`` (default ``n``)
-
-  Toggle display of mailbox messages.
-
-- ``CONFIG_RTE_LIBRTE_LIO_DEBUG_REGS`` (default ``n``)
-
-  Toggle display of register reads and writes.
-
-
 SR-IOV: Prerequisites and Sample Application Notes
 --------------------------------------------------
 
doc/guides/nics/memif.rst +5 -5
index ddeebed25c..6c6227f979 100644
@@ -213,15 +213,15 @@ In this example we run two instances of testpmd application and transmit packets
 
 First create ``master`` interface::
 
-    #./build/app/testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=master -- -i
+    #./<build_dir>/app/dpdk-testpmd -l 0-1 --proc-type=primary --file-prefix=pmd1 --vdev=net_memif,role=master -- -i
 
 Now create ``slave`` interface (master must be already running so the slave will connect)::
 
-    #./build/app/testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i
+    #./<build_dir>/app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif -- -i
 
 You can also enable ``zero-copy`` on ``slave`` interface::
 
-    #./build/app/testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i
+    #./<build_dir>/app/dpdk-testpmd -l 2-3 --proc-type=primary --file-prefix=pmd2 --vdev=net_memif,zero-copy=yes --single-file-segments -- -i
 
 Start forwarding packets::
 
@@ -257,7 +257,7 @@ To see socket filename use show memif command::
 
 Now create memif interface by running testpmd with these command line options::
 
-    #./testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i
+    #./dpdk-testpmd --vdev=net_memif,socket=/run/vpp/memif.sock -- -i
 
 Testpmd should now create memif slave interface and try to connect to master.
 In testpmd set forward option to icmpecho and start forwarding::
@@ -280,7 +280,7 @@ The situation is analogous to cross connecting 2 ports of the NIC by cable.
 
 To set the loopback, just use the same socket and id with different roles::
 
-    #./testpmd --vdev=net_memif0,role=master,id=0 --vdev=net_memif1,role=slave,id=0 -- -i
+    #./dpdk-testpmd --vdev=net_memif0,role=master,id=0 --vdev=net_memif1,role=slave,id=0 -- -i
 
 Then start the communication::
 
doc/guides/nics/mlx4.rst +3 -52

79 lines not on this page · raw message

doc/guides/nics/mlx5.rst +3 -59

86 lines not on this page · raw message

doc/guides/nics/mvneta.rst +8 -28
index c8b00ddf22..e8abde42da 100644
@@ -13,12 +13,6 @@ Detailed information about SoCs that use PPv2 can be obtained here:
 
 * https://www.marvell.com/embedded-processors/armada-3700/
 
-.. Note::
-
-   Due to external dependencies, this driver is disabled by default. It must
-   be enabled manually by setting relevant configuration option manually.
-   Please refer to `Config File Options`_ section for further details.
-
 
 Features
 --------
@@ -81,20 +75,9 @@ Prerequisites
   Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup
   DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_MVNETA_PMD`` (default ``n``)
-
-    Toggle compilation of the librte_pmd_mvneta driver.
 
 Runtime options
-~~~~~~~~~~~~~~~
+---------------
 
 The following ``devargs`` options can be enabled at runtime. They must
 be passed as part of EAL arguments.
@@ -107,7 +90,7 @@ be passed as part of EAL arguments.
 
 .. code-block:: console
 
-   ./testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 \
+   ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 \
     -c 3 -- -i --p 3 -a
 
 
@@ -126,16 +109,13 @@ Driver needs precompiled MUSDK library during compilation.
 MUSDK will be installed to `usr/local` under current directory.
 For the detailed build instructions please consult ``doc/musdk_get_started.txt``.
 
-Before the DPDK build process the environmental variable ``LIBMUSDK_PATH`` with
-the path to the MUSDK installation directory needs to be exported.
+The path to the MUSDK installation directory needs to set in meson, shown in the
+following command:
 
 .. code-block:: console
 
-   export LIBMUSDK_PATH=<musdk>/usr/local
-   export CROSS=aarch64-linux-gnu-
-   make config T=arm64-armv8a-linux-gcc
-   sed -ri 's,(MVNETA_PMD=)n,\1y,' build/.config
-   make
+   meson -Dlib_musdk_dir=/path/to/musdk build ninja -C build
+
 
 Usage Example
 -------------
@@ -160,7 +140,7 @@ In order to run testpmd example application following command can be used:
 
 .. code-block:: console
 
-   ./testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- \
+   ./dpdk-testpmd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- \
      -i --p 3 -a --txd 256 --rxd 128 --rxq=1 --txq=1  --nb-cores=1
 
 
@@ -168,4 +148,4 @@ In order to run l2fwd example application following command can be used:
 
 .. code-block:: console
 
-   ./l2fwd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- -T 1 -p 3
+   ./dpdk-l2fwd --vdev=net_mvneta,iface=eth0,iface=eth1 -c 3 -- -T 1 -p 3
doc/guides/nics/mvpp2.rst +8 -35

97 lines not on this page · raw message

doc/guides/nics/nfb.rst +2 -17
index 10f33a025e..ecea3ecff0 100644
@@ -16,13 +16,6 @@ and used technology
 (`Netcope Development Kit <http://www.netcope.com/en/products/fpga-development-kit>`_)
 can be found on the `Netcope Technologies website <http://www.netcope.com/>`_.
 
-.. note::
-
-   This driver has external dependencies.
-   Therefore it is disabled in default configuration files.
-   It can be enabled by setting ``CONFIG_RTE_LIBRTE_NFB_PMD=y``
-   and recompiling.
-
 .. note::
 
    Currently the driver is supported only on x86_64 architectures.
@@ -62,14 +55,6 @@ The minimum version of the provided packages:
 Configuration
 -------------
 
-These configuration options can be modified before compilation in the
-``.config`` file:
-
-*  ``CONFIG_RTE_LIBRTE_NFB_PMD`` default value: **n**
-
-   Value **y** enables compilation of nfb PMD.
-
-
 Timestamps
 
 The PMD supports hardware timestamps of frame receipt on physical network interface. In order to use
@@ -78,7 +63,7 @@ products) and the device argument `timestamp=1` must be used.
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params>
+    ./<build_dir>/app/dpdk-testpmd -w b3:00.0,timestamp=1 <other EAL params> -- <testpmd params>
 
 When the timestamps are enabled with the *devarg*, a timestamp validity flag is set in the MBUFs
 containing received frames and timestamp is inserted into the `rte_mbuf` struct.
@@ -133,7 +118,7 @@ transmit queue:
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 2 \
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 2 \
    -- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2 -i -a
 
 Example output:
doc/guides/nics/nfp.rst +0 -4
index 5f2a0698f6..6aa58f4358 100644
@@ -49,10 +49,6 @@ compile it along with other DPDK PMDs even if no BSP was installed previously.
 Of course, a DPDK app will require such a BSP installed for using the
 NFP PMD, along with a specific NFP firmware application.
 
-Default PMD configuration is at the **common_linux configuration** file:
-
-- **CONFIG_RTE_LIBRTE_NFP_PMD=y**
-
 Once the DPDK is built all the DPDK apps and examples include support for
 the NFP PMD.
 
doc/guides/nics/null.rst +3 -3
index c68d0d6051..e75abd96d2 100644
@@ -14,7 +14,7 @@ Usage
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i
 
 
 Runtime Config Options
@@ -26,7 +26,7 @@ Runtime Config Options
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,copy=1" -- -i
 
 - ``size`` [optional, default=64 bytes]
 
@@ -35,7 +35,7 @@ Runtime Config Options
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev "net_null0,size=256" -- -i
 
 - ``no-rx`` [optional, default disabled]
 
doc/guides/nics/octeontx.rst +1 -18
index c8655bf375..c01ae09bb3 100644
@@ -52,15 +52,6 @@ See :doc:`../platform/octeontx` for setup information.
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_OCTEONTX_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_octeontx`` driver.
 
 Driver compilation and testing
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -68,14 +59,6 @@ Driver compilation and testing
 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 for details.
 
-To compile the OCTEON TX PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-thunderx-linux-gcc install
-
 #. Running testpmd:
 
    Follow instructions available in the document
@@ -86,7 +69,7 @@ following ``make`` command:
 
    .. code-block:: console
 
-      ./arm64-thunderx-linux-gcc/app/testpmd -c 700 \
+      ./<build_dir>/app/dpdk-testpmd -c 700 \
                 --base-virtaddr=0x100000000000 \
                 --mbuf-pool-ops-name="octeontx_fpavf" \
                 --vdev='event_octeontx' \
doc/guides/nics/octeontx2.rst +1 -12
index bb591a8b7e..903b52b802 100644
@@ -46,14 +46,6 @@ Prerequisites
 
 See :doc:`../platform/octeontx2` for setup information.
 
-Compile time Config Options
----------------------------
-
-The following options may be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_OCTEONTX2_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_octeontx2`` driver.
 
 Driver compilation and testing
 ------------------------------
@@ -61,9 +53,6 @@ Driver compilation and testing
 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 for details.
 
-To compile the OCTEON TX2 PMD for Linux arm64 gcc,
-use arm64-octeontx2-linux-gcc as target.
-
 #. Running testpmd:
 
    Follow instructions available in the document
@@ -74,7 +63,7 @@ use arm64-octeontx2-linux-gcc as target.
 
    .. code-block:: console
 
-      ./build/app/testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1
+      ./<build_dir>/app/dpdk-testpmd -c 0x300 -w 0002:02:00.0 -- --portmask=0x1 --nb-cores=1 --port-topology=loop --rxq=1 --txq=1
       EAL: Detected 24 lcore(s)
       EAL: Detected 1 NUMA nodes
       EAL: Multi-process socket /var/run/dpdk/rte/mp_socket
doc/guides/nics/pcap_ring.rst +11 -13
index cf230ae40a..67bd23ea4a 100644
@@ -15,10 +15,8 @@ the DPDK also includes pure-software PMDs, two of these drivers are:
 
 .. note::
 
-    The libpcap -based PMD is disabled by default in the build configuration files,
-    owing to an external dependency on the libpcap development files which must be installed on the board.
-    Once the libpcap development files are installed,
-    the library can be enabled by setting CONFIG_RTE_LIBRTE_PMD_PCAP=y and recompiling the DPDK.
+    The libpcap -based PMD has an external dependency on the libpcap development files which must
+    be installed on the board.
 
 Using the Drivers from the EAL Command Line
 -------------------------------------------
@@ -42,7 +40,7 @@ Device name and stream options must be separated by commas as shown below:
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
        --vdev 'net_pcap0,stream_opt0=..,stream_opt1=..' \
        --vdev='net_pcap1,stream_opt0=..'
 
@@ -141,7 +139,7 @@ Read packets from one pcap file and write them to another:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \
         -- --port-topology=chained
 
@@ -149,7 +147,7 @@ Read packets from a network interface and write them to a pcap file:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_iface=eth0,tx_pcap=file_tx.pcap' \
         -- --port-topology=chained
 
@@ -157,7 +155,7 @@ Read packets from a pcap file and write them to a network interface:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_iface=eth1' \
         -- --port-topology=chained
 
@@ -165,14 +163,14 @@ Forward packets through two network interfaces:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,iface=eth0' --vdev='net_pcap1;iface=eth1'
 
 Enable 2 tx queues on a network interface:
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_iface=eth1,tx_iface=eth1,tx_iface=eth1' \
         -- --txq 2
 
@@ -180,7 +178,7 @@ Read only incoming packets from a network interface and write them back to the s
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_iface_in=eth1,tx_iface=eth1'
 
 Using libpcap-based PMD with the testpmd Application
@@ -205,7 +203,7 @@ Otherwise, the first 512 packets from the input pcap file will be discarded by t
 
 .. code-block:: console
 
-    $RTE_TARGET/app/testpmd -l 0-3 -n 4 \
+    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 \
         --vdev 'net_pcap0,rx_pcap=file_rx.pcap,tx_pcap=file_tx.pcap' \
         -- --port-topology=chained --no-flush-rx
 
@@ -225,7 +223,7 @@ Multiple devices may be specified, separated by commas.
 
 .. code-block:: console
 
-    ./testpmd -l 1-3 -n 4 --vdev=net_ring0 --vdev=net_ring1 -- -i
+    ./dpdk-testpmd -l 1-3 -n 4 --vdev=net_ring0 --vdev=net_ring1 -- -i
     EAL: Detected lcore 1 as core 1 on socket 0
     ...
 
doc/guides/nics/qede.rst +2 -15
index 5b2f868952..6df0066dd4 100644
@@ -111,22 +111,9 @@ Performance note
 Config File Options
 ~~~~~~~~~~~~~~~~~~~
 
-The following options can be modified in the ``.config`` file. Please note that
-enabling debugging options may affect system performance.
+The following option can be modified in the ``config/rte_config.h`` file.
 
-- ``CONFIG_RTE_LIBRTE_QEDE_PMD`` (default **y**)
-
-  Toggle compilation of QEDE PMD driver.
-
-- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_TX`` (default **n**)
-
-  Toggle display of transmit fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_RX`` (default **n**)
-
-  Toggle display of receive fast path run-time messages.
-
-- ``CONFIG_RTE_LIBRTE_QEDE_FW`` (default **""**)
+- ``RTE_LIBRTE_QEDE_FW`` (default **""**)
 
   Gives absolute path of firmware file.
   ``Eg: "/lib/firmware/qed/qed_init_values-8.40.33.0.bin"``
doc/guides/nics/sfc_efx.rst +0 -15
index be1c2fe1d6..6ee5190f3c 100644
@@ -271,21 +271,6 @@ Pre-Installation Configuration
 ------------------------------
 
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``.config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
-
-  Enable compilation of Solarflare libefx-based poll-mode driver.
-
-- ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
-
-  Enable compilation of the extra run-time consistency checks.
-
-
 Per-Device Parameters
 ~~~~~~~~~~~~~~~~~~~~~
 
doc/guides/nics/softnic.rst +2 -11
index 8f0dd53eac..695ebed91f 100644
@@ -51,15 +51,6 @@ Any Linux distribution fulfilling the conditions described in ``System Requireme
 section of :ref:`the DPDK documentation <linux_gsg>` or refer to *DPDK
 Release Notes*.
 
-Build options
--------------
-
-The default PMD configuration available in the common_linux configuration file:
-
-CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y
-
-Once the DPDK is built, all the DPDK applications include support for the
-Soft NIC PMD.
 
 Soft NIC PMD arguments
 ----------------------
@@ -130,7 +121,7 @@ Soft NIC testing
 
     .. code-block:: console
 
-         ./testpmd -c 0x7 -s 0x4 --vdev 'net_softnic0,firmware=<script path>/firmware.cli,cpu_id=0,conn_port=8086' -- -i
+         ./dpdk-testpmd -c 0x7 -s 0x4 --vdev 'net_softnic0,firmware=<script path>/firmware.cli,cpu_id=0,conn_port=8086' -- -i
               --portmask=0x2
 
     .. code-block:: console
@@ -375,7 +366,7 @@ commands.
 
     .. code-block:: console
 
-        ./x86_64-native-linux-gcc/app/testpmd -c 0x7 -s 0x4 -n 4 \
+        ./<build_dir>/app/dpdk-testpmd -c 0x7 -s 0x4 -n 4 \
                                     --vdev 'net_softnic0, \
                                     firmware=./drivers/net/softnic/ \
                                         firmware.cli, \
doc/guides/nics/szedata2.rst +1 -17
index 30710a80b8..9cf3f39eb5 100644
@@ -15,13 +15,6 @@ and used technology
 (`Netcope Development Kit <http://www.netcope.com/en/products/fpga-development-kit>`_)
 can be found on the `Netcope Technologies website <http://www.netcope.com/>`_.
 
-.. note::
-
-   This driver has external dependencies.
-   Therefore it is disabled in default configuration files.
-   It can be enabled by setting ``CONFIG_RTE_LIBRTE_PMD_SZEDATA2=y``
-   and recompiling.
-
 .. note::
 
    Currently the driver is supported only on x86_64 architectures.
@@ -63,15 +56,6 @@ The minimum version of the provided packages:
 
 * for DPDK up to 18.02 (including): **3.0.5**
 
-Configuration
--------------
-
-These configuration options can be modified before compilation in the
-``.config`` file:
-
-*  ``CONFIG_RTE_LIBRTE_PMD_SZEDATA2`` default value: **n**
-
-   Value **y** enables compilation of szedata2 PMD.
 
 Using the SZEDATA2 PMD
 ----------------------
@@ -129,7 +113,7 @@ transmit channel:
 
 .. code-block:: console
 
-   $RTE_TARGET/app/testpmd -l 0-3 -n 2 \
+   ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 2 \
    -- --port-topology=chained --rxq=2 --txq=2 --nb-cores=2 -i -a
 
 Example output:
doc/guides/nics/thunderx.rst +2 -23
index b1ef9eba59..a928a790e3 100644
@@ -43,26 +43,6 @@ Prerequisites
 -------------
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_PMD`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_thunderx_nicvf`` driver.
-
-- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_RX`` (default ``n``)
-
-  Toggle asserts of receive fast path.
-
-- ``CONFIG_RTE_LIBRTE_THUNDERX_NICVF_DEBUG_TX`` (default ``n``)
-
-  Toggle asserts of transmit fast path.
 
 Driver compilation and testing
 ------------------------------
@@ -70,8 +50,7 @@ Driver compilation and testing
 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 for details.
 
-To compile the ThunderX NICVF PMD for Linux arm64 gcc,
-use arm64-thunderx-linux-gcc as target.
+Use config/arm/arm64-thunderx-linux-gcc as a meson cross-file when cross-compiling.
 
 Linux
 -----
@@ -178,7 +157,7 @@ This section provides instructions to configure SR-IOV with Linux OS.
 
    .. code-block:: console
 
-      ./arm64-thunderx-linux-gcc/app/testpmd -l 0-3 -n 4 -w 0002:01:00.2 \
+      ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 -w 0002:01:00.2 \
         -- -i --no-flush-rx \
         --port-topology=loop
 
doc/guides/nics/vdev_netvsc.rst +0 -6
index d1da071187..d9f6319b9f 100644
@@ -61,12 +61,6 @@ This driver implementation may be temporary and should be improved or removed
 either when hot-plug will be fully supported in EAL and bus drivers or when
 a new NetVSC driver will be integrated.
 
-Build options
--------------
-
-- ``CONFIG_RTE_LIBRTE_VDEV_NETVSC_PMD`` (default ``y``)
-
-   Toggle compilation of this driver.
 
 Run-time parameters
 -------------------
doc/guides/nics/vhost.rst +1 -1
index d36f3120b2..ee802ec4a8 100644
@@ -90,7 +90,7 @@ This section demonstrates vhost PMD with testpmd DPDK sample application.
 
     .. code-block:: console
 
-        ./testpmd -l 0-3 -n 4 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i
+        ./dpdk-testpmd -l 0-3 -n 4 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i
 
     Other basic DPDK preparations like hugepage enabling here.
     Please refer to the *DPDK Getting Started Guide* for detailed instructions.
doc/guides/nics/virtio.rst +2 -2
index 0daf25b22d..a51b389685 100644
@@ -110,7 +110,7 @@ Host2VM communication example
 
     .. code-block:: console
 
-        examples/kni/build/app/kni -l 0-3 -n 4 -- -p 0x1 -P --config="(0,1,3)"
+        <build_dir>/examples/dpdk-kni -l 0-3 -n 4 -- -p 0x1 -P --config="(0,1,3)"
 
     This command generates one network device vEth0 for physical port.
     If specify more physical ports, the generated network device will be vEth1, vEth2, and so on.
@@ -340,7 +340,7 @@ Here we use l3fwd-power as an example to show how to get started.
 
     .. code-block:: console
 
-        $ l3fwd-power -l 0-1 -- -p 1 -P --config="(0,0,1)" \
+        $ dpdk-l3fwd-power -l 0-1 -- -p 1 -P --config="(0,0,1)" \
                                                --no-numa --parse-ptype
 
 
Signature · 1 line
2.17.1
#232 lore raw

PATCH v5 10/20 doc: remove references to make from vdpadevs guides

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/vdpadevs/ifc.rst  | 13 ------------
 doc/guides/vdpadevs/mlx5.rst | 40 +++---------------------------------
 2 files changed, 3 insertions(+), 50 deletions(-)
doc/guides/vdpadevs/ifc.rst +0 -13
index 12a2a342e6..f968489a75 100644
@@ -11,19 +11,6 @@ directly by DMA. Besides, it supports dirty page logging and device state
 report/restore, this driver enables its vDPA functionality.
 
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following option can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_IFC_PMD`` (default ``y`` for linux)
-
-  Toggle compilation of the ``librte_pmd_ifc`` driver.
-
-
 IFCVF vDPA Implementation
 -------------------------
 
doc/guides/vdpadevs/mlx5.rst +3 -37
index 2c7a550afc..2717459b6f 100644
@@ -14,9 +14,7 @@ SR-IOV context.
 
 .. note::
 
-   Due to external dependencies, this driver is disabled in default
-   configuration of the "make" build. It can be enabled with
-   ``CONFIG_RTE_LIBRTE_MLX5_VDPA_PMD=y`` or by using "meson" build system which
+   This driver is enabled automatically when using "meson" build system which
    will detect dependencies.
 
 
@@ -65,42 +63,10 @@ Prerequisites
 Compilation options
 ~~~~~~~~~~~~~~~~~~~
 
-These options can be modified in the ``.config`` file.
-
-- ``CONFIG_RTE_LIBRTE_MLX5_VDPA_PMD`` (default **n**)
-
-  Toggle compilation of librte_pmd_mlx5 itself.
-
-- ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
-
-  Build PMD with additional code to make it loadable without hard
-  dependencies on **libibverbs** nor **libmlx5**, which may not be installed
-  on the target system.
-
-  In this mode, their presence is still required for it to run properly,
-  however their absence won't prevent a DPDK application from starting (with
-  ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
-  missing with ``ldd(1)``.
-
-  It works by moving these dependencies to a purpose-built rdma-core "glue"
-  plug-in which must either be installed in a directory whose name is based
-  on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a
-  standard location for the dynamic linker (e.g. ``/lib``) if left to the
-  default empty string (``""``).
-
-  This option has no performance impact.
-
-- ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
-
-  Embed static flavor of the dependencies **libibverbs** and **libmlx5**
-  in the PMD shared library or the executable static binary.
-
 .. note::
 
-   For BlueField, target should be set to ``arm64-bluefield-linux-gcc``. This
-   will enable ``CONFIG_RTE_LIBRTE_MLX5_VDPA_PMD`` and set
-   ``RTE_CACHE_LINE_SIZE`` to 64. Default armv8a configuration of make build and
-   meson build set it to 128 then brings performance degradation.
+   Default armv8a configuration of meson build sets ``RTE_CACHE_LINE_SIZE``
+   to 128 then brings performance degradation.
 
 Run-time configuration
 ~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.17.1
#233 lore raw

PATCH v5 11/20 doc: remove references to make from bbdevs guides

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
v5: Added meson steps to turbo_sw doc.

---
 doc/guides/bbdevs/fpga_5gnr_fec.rst |  7 ++-----
 doc/guides/bbdevs/fpga_lte_fec.rst  |  7 ++-----
 doc/guides/bbdevs/turbo_sw.rst      | 23 ++++++++---------------
 3 files changed, 12 insertions(+), 25 deletions(-)
doc/guides/bbdevs/fpga_5gnr_fec.rst +2 -5
index 6760391e8c..8e00c4ef22 100644
@@ -51,10 +51,7 @@ FPGA 5GNR FEC does not support the following:
 Installation
 ------------
 
-Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. The
-default set of bbdev compile flags may be found in config/common_base, where for example
-the flag to build the FPGA 5GNR FEC device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_5GNR_FEC``,
-is already set.
+Section 3 of the DPDK manual provides instructions on installing and compiling DPDK.
 
 DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual.
 The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The
@@ -94,7 +91,7 @@ the UIO driver by repeating this command for every function.
 .. code-block:: console
 
   cd <dpdk-top-level-directory>
-  insmod ./build/kmod/igb_uio.ko
+  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
   echo "8086 0d8f" > /sys/bus/pci/drivers/igb_uio/new_id
   lspci -vd8086:0d8f
 
doc/guides/bbdevs/fpga_lte_fec.rst +2 -5
index fdc8a76981..14ffa0ee14 100644
@@ -50,10 +50,7 @@ FPGA LTE FEC does not support the following:
 Installation
 --------------
 
-Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. The
-default set of bbdev compile flags may be found in config/common_base, where for example
-the flag to build the FPGA LTE FEC device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_FPGA_LTE_FEC``, is already
-set.
+Section 3 of the DPDK manual provides instructions on installing and compiling DPDK.
 
 DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual.
 The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The
@@ -93,7 +90,7 @@ the UIO driver by repeating this command for every function.
 .. code-block:: console
 
   cd <dpdk-top-level-directory>
-  insmod ./build/kmod/igb_uio.ko
+  insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
   echo "1172 5052" > /sys/bus/pci/drivers/igb_uio/new_id
   lspci -vd1172:
 
doc/guides/bbdevs/turbo_sw.rst +8 -15
index 20620c2e20..43c5129fd7 100644
@@ -12,14 +12,6 @@ Note that the driver can also be built without any dependency with reduced
 functionality for maintenance purpose.
 
 To enable linking to the SDK libraries see detailed installation section below.
-Two flags can be enabled depending on whether the target machine can support
-AVX2 and AVX512 instructions sets and the related SDK libraries for vectorized
-signal processing functions are installed :
-- CONFIG_RTE_BBDEV_SDK_AVX2
-- CONFIG_RTE_BBDEV_SDK_AVX512
-By default these 2 flags are disabled by default. For AVX2 machine and SDK
-library installed then the first flag can be enabled. For AVX512 machine and
-SDK library installed then both flags can be enabled for full real time capability.
 
 This PMD supports the functions: FEC, Rate Matching and CRC functions detailed
 in the Features section.
@@ -144,20 +136,21 @@ In order to enable this virtual bbdev PMD, the user may:
   FlexRAN SDK libraries were installed. And ``DIR_WIRELESS_SDK`` to the path
   where the libraries were extracted.
 
+* Tune the meson build option pointing the location of the FlexRAN SDK libraries ``flexran_sdk``
+
 Example:
 
 .. code-block:: console
 
     export FLEXRAN_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/install
     export DIR_WIRELESS_SDK=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx2-icc/
+    cd build
+    meson configure -Dflexran_sdk=<path-to-workspace>/FlexRAN-FEC-SDK-19-04/sdk/build-avx512-icc/install
+
+* For AVX512 machines with SDK libraries installed then both 4G and 5G can be enabled for full real time FEC capability.
+  For AVX2 machines it is possible to only enable the 4G libraries and the PMD capabilities will be limited to 4G FEC.
+  If no library is present then the PMD driver will still build but its capabilities will be limited accordingly.
 
-* Set ``CONFIG_RTE_BBDEV_SDK_AVX2=y`` and ``CONFIG_RTE_BBDEV_SDK_AVX512=y``
-  in DPDK common configuration file ``config/common_base`` to be able to use
-  the SDK libraries as mentioned above.
-  For AVX2 machine it is possible to only enable CONFIG_RTE_BBDEV_SDK_AVX2
-  for limited 4G functionality.
-  If no flag are set the PMD driver will still build but its capabilities
-  will be limited accordingly.
 
 To use the PMD in an application, user must:
 
Signature · 1 line
2.17.1
#234 lore raw

PATCH v5 12/20 doc: remove references to make from cryptodevs guides

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/cryptodevs/aesni_gcm.rst |  4 +-
 doc/guides/cryptodevs/aesni_mb.rst  |  4 +-
 doc/guides/cryptodevs/armv8.rst     |  3 --
 doc/guides/cryptodevs/caam_jr.rst   | 30 -------------
 doc/guides/cryptodevs/ccp.rst       | 14 +++---
 doc/guides/cryptodevs/dpaa2_sec.rst | 25 -----------
 doc/guides/cryptodevs/dpaa_sec.rst  | 25 -----------
 doc/guides/cryptodevs/kasumi.rst    | 11 +----
 doc/guides/cryptodevs/mvsam.rst     | 10 +----
 doc/guides/cryptodevs/nitrox.rst    |  7 ---
 doc/guides/cryptodevs/null.rst      |  2 +-
 doc/guides/cryptodevs/octeontx.rst  | 12 +-----
 doc/guides/cryptodevs/octeontx2.rst |  8 +---
 doc/guides/cryptodevs/openssl.rst   |  6 +--
 doc/guides/cryptodevs/qat.rst       | 67 +++++++----------------------
 doc/guides/cryptodevs/scheduler.rst |  8 ----
 doc/guides/cryptodevs/snow3g.rst    | 10 +----
 doc/guides/cryptodevs/virtio.rst    | 20 +++------
 doc/guides/cryptodevs/zuc.rst       | 10 +----
 19 files changed, 40 insertions(+), 236 deletions(-)
doc/guides/cryptodevs/aesni_gcm.rst +1 -3
index 74e0de63ad..013615e2d0 100644
@@ -96,8 +96,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Set CONFIG_RTE_LIBRTE_PMD_AESNI_GCM=y in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_aesni_gcm") within the application.
@@ -117,5 +115,5 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_gcm,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain AEAD --aead_algo "aes-gcm"
doc/guides/cryptodevs/aesni_mb.rst +1 -3
index 15388d20ab..fd533ca65b 100644
@@ -131,8 +131,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Set CONFIG_RTE_LIBRTE_PMD_AESNI_MB=y in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_aesni_mb") within the application.
@@ -152,7 +150,7 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_aesni_mb,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_HASH --cipher_algo "aes-cbc" --auth_algo "sha1-hmac"
 
 Extra notes
doc/guides/cryptodevs/armv8.rst +0 -3
index fee85354ba..d30ef6168e 100644
@@ -40,9 +40,6 @@ In order to enable this virtual crypto PMD, user must:
 
 	make -C $ARMV8_CRYPTO_LIB_PATH/
 
-* Set CONFIG_RTE_LIBRTE_PMD_ARMV8_CRYPTO=y in
-  config/defconfig_arm64-armv8a-linux-gcc
-
 The corresponding device can be created only if the following features
 are supported by the CPU:
 
doc/guides/cryptodevs/caam_jr.rst +0 -30
index 6d9daf7364..5ef33ae78e 100644
@@ -109,36 +109,6 @@ Currently supported by DPDK:
 
 * Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file
-to enable caam_jr PMD.
-
-Please note that enabling debugging options may affect system performance.
-
-* ``CONFIG_RTE_LIBRTE_PMD_CAAM_JR`` (default ``n``)
-  By default it is only enabled in common_linux config.
-  Toggle compilation of the ``librte_pmd_caam_jr`` driver.
-
-* ``CONFIG_RTE_LIBRTE_PMD_CAAM_JR_BE`` (default ``n``)
-  By default it is disabled.
-  It can be used when the underlying hardware supports the CAAM in BE mode.
-  LS1043A, LS1046A and LS1012A support CAAM in BE mode.
-  LS1028A supports CAAM in LE mode.
-
-Installations
--------------
-To compile the caam_jr PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-armv8a-linux-gcc install
 
 Enabling logs
 -------------
doc/guides/cryptodevs/ccp.rst +5 -9
index a43fe92de9..9ca1979994 100644
@@ -56,10 +56,8 @@ AEAD algorithms:
 Installation
 ------------
 
-To compile ccp PMD, it has to be enabled in the config/common_base file and openssl
-packages have to be installed in the build environment.
-
-* ``CONFIG_RTE_LIBRTE_PMD_CCP=y``
+To compile ccp PMD, openssl packages have to be installed in the build
+environment.
 
 For Ubuntu 16.04 LTS use below to install openssl in the build system:
 
@@ -77,7 +75,7 @@ e.g. for the 0x1456 device::
 
 	cd to the top-level DPDK directory
 	modprobe uio
-	insmod ./build/kmod/igb_uio.ko
+	insmod ./<build_dir>/kernel/linux/igb_uio/igb_uio.ko
 	echo "1022 1456" > /sys/bus/pci/drivers/igb_uio/new_id
 
 Another way to bind the CCP devices to DPDK UIO driver is by using the ``dpdk-devbind.py`` script.
@@ -86,8 +84,6 @@ The following command assumes ``BFD`` as ``0000:09:00.2``::
 	cd to the top-level DPDK directory
 	./usertools/dpdk-devbind.py -b igb_uio 0000:09:00.2
 
-In order to enable the ccp crypto PMD, user must set CONFIG_RTE_LIBRTE_PMD_CCP=y in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_ccp") within the application.
@@ -109,7 +105,7 @@ To validate ccp pmd, l2fwd-crypto example can be used with following command:
 
 .. code-block:: console
 
-        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
+        sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp" -- -p 0x1
         --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc
         --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
         --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
@@ -124,7 +120,7 @@ following:
 
 .. code-block:: console
 
-        sudo ./build/l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1
+        sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 1 -n 4 --vdev "crypto_ccp,ccp_auth_opt=1" -- -p 0x1
         --chain CIPHER_HASH --cipher_op ENCRYPT --cipher_algo aes-cbc
         --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
         --cipher_iv 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:ff
doc/guides/cryptodevs/dpaa2_sec.rst +0 -25
index 3053636b82..080768a2e7 100644
@@ -167,31 +167,6 @@ Currently supported by DPDK:
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-Basic DPAA2 config file options are described in :ref:`dpaa2_overview`.
-In addition to those, the following options can be modified in the ``config`` file
-to enable DPAA2_SEC PMD.
-
-Please note that enabling debugging options may affect system performance.
-
-* ``CONFIG_RTE_LIBRTE_PMD_DPAA2_SEC`` (default ``n``)
-  By default it is only enabled in defconfig_arm64-dpaa-* config.
-  Toggle compilation of the ``librte_pmd_dpaa2_sec`` driver.
-
-Installations
--------------
-To compile the DPAA2_SEC PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Enabling logs
 -------------
doc/guides/cryptodevs/dpaa_sec.rst +0 -25
index db3c8e9189..da14a68d9c 100644
@@ -111,31 +111,6 @@ See :doc:`../platform/dpaa` for setup information
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-Basic DPAA config file options are described in :ref:`dpaa_overview`.
-In addition to those, the following options can be modified in the ``config`` file
-to enable DPAA_SEC PMD.
-
-Please note that enabling debugging options may affect system performance.
-
-* ``CONFIG_RTE_LIBRTE_PMD_DPAA_SEC`` (default ``n``)
-  By default it is only enabled in defconfig_arm64-dpaa-* config.
-  Toggle compilation of the ``librte_pmd_dpaa_sec`` driver.
-
-Installations
--------------
-To compile the DPAA_SEC PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Enabling logs
 -------------
doc/guides/cryptodevs/kasumi.rst +1 -10
index 09a538f816..5770a60cb2 100644
@@ -89,15 +89,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Build DPDK as follows:
-
-.. code-block:: console
-
-	make config T=x86_64-native-linux-gcc
-	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_KASUMI\)=n,\1=y,' build/.config
-	make
-
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_kasumi") within the application.
@@ -117,7 +108,7 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_kasumi,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "kasumi-f8"
 
 Extra notes on KASUMI F9
doc/guides/cryptodevs/mvsam.rst +1 -9
index 399fe37a67..6188c1248c 100644
@@ -64,14 +64,6 @@ Limitations
 Installation
 ------------
 
-MVSAM CRYPTO PMD driver compilation is disabled by default due to external dependencies.
-Currently there are two driver specific compilation options in
-``config/common_base`` available:
-
-- ``CONFIG_RTE_LIBRTE_PMD_MVSAM_CRYPTO`` (default: ``n``)
-
-    Toggle compilation of the librte_pmd_mvsam driver.
-
 MVSAM CRYPTO PMD requires MUSDK built with EIP197 support thus following
 extra option must be passed to the library configuration script:
 
@@ -105,7 +97,7 @@ operation:
 
 .. code-block:: console
 
-   ./l2fwd-crypto --vdev=eth_mvpp2,iface=eth0 --vdev=crypto_mvsam -- \
+   ./dpdk-l2fwd-crypto --vdev=eth_mvpp2,iface=eth0 --vdev=crypto_mvsam -- \
      --cipher_op ENCRYPT --cipher_algo aes-cbc \
      --cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f  \
      --auth_op GENERATE --auth_algo sha1-hmac \
doc/guides/cryptodevs/nitrox.rst +0 -7
index 85f5212b64..2f0565b49e 100644
@@ -33,13 +33,6 @@ Limitations
 * 3DES Cipher Only combination is not supported.
 * Session-less APIs are not supported.
 
-Installation
-------------
-
-For compiling the Nitrox crypto PMD, please check if the
-CONFIG_RTE_LIBRTE_PMD_NITROX setting is set to `y` in config/common_base file.
-
-* ``CONFIG_RTE_LIBRTE_PMD_NITROX=y``
 
 Initialization
 --------------
doc/guides/cryptodevs/null.rst +1 -1
index c980e0ac84..aac5904b1d 100644
@@ -67,5 +67,5 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
doc/guides/cryptodevs/octeontx.rst +2 -10
index 4fa199e3c4..d813cb2974 100644
@@ -59,14 +59,6 @@ Supported Asymmetric Crypto Algorithms
 * ``RTE_CRYPTO_ASYM_XFORM_RSA``
 * ``RTE_CRYPTO_ASYM_XFORM_MODEX``
 
-Config flags
-------------
-
-For compiling the OCTEON TX crypto poll mode driver, please check if the
-CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO setting is set to `y` in
-config/common_base file.
-
-* ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO=y``
 
 Compilation
 -----------
@@ -135,7 +127,7 @@ application:
 
 .. code-block:: console
 
-        ./test
+        ./dpdk-test
         RTE>>cryptodev_octeontx_autotest
 
 The asymmetric crypto operations on OCTEON TX crypto PMD may be verified by running the test
@@ -143,5 +135,5 @@ application:
 
 .. code-block:: console
 
-        ./test
+        ./dpdk-test
         RTE>>cryptodev_octeontx_asym_autotest
doc/guides/cryptodevs/octeontx2.rst +2 -6
index 432146db04..bb4af3a04d 100644
@@ -70,10 +70,6 @@ Installation
 The OCTEON TX2 crypto PMD may be compiled natively on an OCTEON TX2 platform or
 cross-compiled on an x86 platform.
 
-Enable OCTEON TX2 crypto PMD in your config file:
-
-* ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_CRYPTO=y``
-
 Refer to :doc:`../platform/octeontx2` for instructions to build your DPDK
 application.
 
@@ -148,7 +144,7 @@ application:
 
 .. code-block:: console
 
-    ./test
+    ./dpdk-test
     RTE>>cryptodev_octeontx2_autotest
 
 The asymmetric crypto operations on OCTEON TX2 crypto PMD may be verified by running the test
@@ -156,7 +152,7 @@ application:
 
 .. code-block:: console
 
-    ./test
+    ./dpdk-test
     RTE>>cryptodev_octeontx2_asym_autotest
 
 
doc/guides/cryptodevs/openssl.rst +3 -3
index 7407294813..ca0f0b43f3 100644
@@ -58,8 +58,8 @@ Supported Asymmetric Crypto algorithms:
 Installation
 ------------
 
-To compile openssl PMD, it has to be enabled in the config/common_base file
-and appropriate openssl packages have to be installed in the build environment.
+To compile openssl PMD, appropriate openssl packages have to be installed
+in the build environment.
 
 The newest openssl library version is supported:
 
@@ -93,7 +93,7 @@ To verify real traffic l2fwd-crypto example can be used with this command:
 
 .. code-block:: console
 
-	sudo ./build/l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_openssl"
+	sudo ./<build_dir>/examples/dpdk-l2fwd-crypto -l 0-1 -n 4 --vdev "crypto_openssl"
 	--vdev "crypto_openssl"-- -p 0x3 --chain CIPHER_HASH
 	--cipher_op ENCRYPT --cipher_algo AES_CBC
 	--cipher_key 00:01:02:03:04:05:06:07:08:09:0a:0b:0c:0d:0e:0f
doc/guides/cryptodevs/qat.rst +16 -51

129 lines not on this page · raw message

doc/guides/cryptodevs/scheduler.rst +0 -8
index 7004ca431a..ee23b25b73 100644
@@ -32,14 +32,6 @@ Limitations
   is enabled.
 
 
-Installation
-------------
-
-To build DPDK with CRYTPO_SCHEDULER_PMD the user is required to set
-CONFIG_RTE_LIBRTE_PMD_CRYPTO_SCHEDULER=y in config/common_base, and
-recompile DPDK
-
-
 Initialization
 --------------
 
doc/guides/cryptodevs/snow3g.rst +1 -9
index e0cddc2d77..13341c39c4 100644
@@ -88,14 +88,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Build DPDK as follows:
-
-.. code-block:: console
-
-	make config T=x86_64-native-linux-gcc
-	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_SNOW3G\)=n,\1=y,' build/.config
-	make
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_snow3g") within the application.
@@ -115,5 +107,5 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_snow3g,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "snow3g-uea2"
doc/guides/cryptodevs/virtio.rst +5 -15
index 2c46bda866..83d8e32397 100644
@@ -83,27 +83,17 @@ The unit test cases can be tested as below:
 .. code-block:: console
 
     reserve enough huge pages
-    cd to the top-level DPDK directory
-    export RTE_TARGET=x86_64-native-linux-gcc
-    export RTE_SDK=`pwd`
-    cd to app/test
-    type the command "make" to compile
-    run the tests with "./test"
-    type the command "cryptodev_virtio_autotest" to test
+    cd to <build_dir>
+    meson test cryptodev_virtio_autotest
 
 The performance can be tested as below:
 
 .. code-block:: console
 
     reserve enough huge pages
-    cd to the top-level DPDK directory
-    export RTE_TARGET=x86_64-native-linux-gcc
-    export RTE_SDK=`pwd`
-    cd to app/test-crypto-perf
-    type the command "make" to compile
-    run the tests with the following command:
-
-    ./dpdk-test-crypto-perf -l 0,1 -- --devtype crypto_virtio \
+    cd to <build_dir>
+
+    ./app/dpdk-test-crypto-perf -l 0,1 -- --devtype crypto_virtio \
         --ptest throughput --optype cipher-then-auth --cipher-algo aes-cbc \
         --cipher-op encrypt --cipher-key-sz 16 --auth-algo sha1-hmac \
         --auth-op generate --auth-key-sz 64 --digest-sz 12 \
doc/guides/cryptodevs/zuc.rst +1 -9
index 9b51ba141d..907840ef05 100644
@@ -88,14 +88,6 @@ In order to enable this virtual crypto PMD, user must:
 
 * Build the multi buffer library (explained in Installation section).
 
-* Build DPDK as follows:
-
-.. code-block:: console
-
-	make config T=x86_64-native-linux-gcc
-	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_ZUC\)=n,\1=y,' build/.config
-	make
-
 To use the PMD in an application, user must:
 
 * Call rte_vdev_init("crypto_zuc") within the application.
@@ -115,5 +107,5 @@ Example:
 
 .. code-block:: console
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \
+    ./dpdk-l2fwd-crypto -l 1 -n 4 --vdev="crypto_zuc,socket_id=0,max_nb_sessions=128" \
     -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "zuc-eea3"
Signature · 1 line
2.17.1
#235 lore raw

PATCH v5 13/20 doc: remove references to make from compressdevs guides

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/compressdevs/isal.rst     |  4 ----
 doc/guides/compressdevs/octeontx.rst | 24 ++----------------------
 doc/guides/compressdevs/zlib.rst     |  4 ----
 3 files changed, 2 insertions(+), 30 deletions(-)
doc/guides/compressdevs/isal.rst +0 -4
index af1f41f240..1d146fb4a6 100644
@@ -133,10 +133,6 @@ Installation
 Initialization
 --------------
 
-In order to enable this virtual compression PMD, user must:
-
-* Set ``CONFIG_RTE_LIBRTE_PMD_ISAL=y`` in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call ``rte_vdev_init("compress_isal")`` within the application.
doc/guides/compressdevs/octeontx.rst +2 -22
index 5924ad1fa3..8c658721b9 100644
@@ -56,21 +56,6 @@ Steps To Setup Platform
 
    SDK and related information can be obtained from: `Cavium support site <https://support.cavium.com/>`_.
 
-Installation
-------------
-
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the OCTEON TX ZIP PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-   .. code-block:: console
-
-      cd <DPDK-source-directory>
-      make config T=arm64-thunderx-linux-gcc install
-
-
 Initialization
 --------------
 
@@ -96,10 +81,5 @@ probed. To use the PMD in an application, user must:
    .. code-block:: console
 
       reserve enough huge pages
-      cd to the top-level DPDK directory
-      export RTE_TARGET=arm64-thunderx-linux-gcc
-      export RTE_SDK=`pwd`
-      cd to app/test
-      type the command "make" to compile
-      run the tests with "./test"
-      type the command "compressdev_autotest" to test
+      cd to <build_dir>
+      meson test compressdev_autotest
doc/guides/compressdevs/zlib.rst +0 -4
index 986c59d43b..6e397ecd7e 100644
@@ -53,10 +53,6 @@ Installation
 Initialization
 --------------
 
-In order to enable this virtual compression PMD, user must:
-
-* Set ``CONFIG_RTE_LIBRTE_PMD_ZLIB=y`` in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call ``rte_vdev_init("compress_zlib")`` within the application.
Signature · 1 line
2.17.1
Acked-by on v5 13/20
#236 lore raw

Re: [dpdk-dev] [PATCH v5 13/20] doc: remove references to make from compressdevs guides

Quoted 28 lines

-----Original Message-----
From: Power, Ciara <[email protected]>
Sent: Monday, September 21, 2020 2:59 PM
To: [email protected]
Cc: Power, Ciara <[email protected]>; Daly, Lee <[email protected]>; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>; Ashish Gupta <[email protected]>; Sunila Sahu <[email protected]>
Subject: [PATCH v5 13/20] doc: remove references to make from compressdevs guides

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/compressdevs/isal.rst     |  4 ----
 doc/guides/compressdevs/octeontx.rst | 24 ++----------------------
 doc/guides/compressdevs/zlib.rst     |  4 ----
 3 files changed, 2 insertions(+), 30 deletions(-)
doc/guides/compressdevs/isal.rst +0 -0
index af1f41f240..1d146fb4a6 100644

doc/guides/compressdevs/isal.rst Installation · line 138

Quoted 10 lines
doc/guides/compressdevs/isal.rst +0 -4
@@ -133,10 +133,6 @@ Installation
 Initialization
 --------------
 
-In order to enable this virtual compression PMD, user must:
-
-* Set ``CONFIG_RTE_LIBRTE_PMD_ISAL=y`` in config/common_base.
-
 To use the PMD in an application, user must:
 
 * Call ``rte_vdev_init("compress_isal")`` within the application.

<<snip>>

ISA-L change looks good, thanks for work.

#237 lore raw

PATCH v5 14/20 doc: remove references to make from eventdevs guides

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/eventdevs/dpaa.rst      | 20 --------------------
 doc/guides/eventdevs/dpaa2.rst     | 20 --------------------
 doc/guides/eventdevs/octeontx.rst  | 24 ------------------------
 doc/guides/eventdevs/octeontx2.rst |  8 --------
 4 files changed, 72 deletions(-)
doc/guides/eventdevs/dpaa.rst +0 -20
index be68c6da6f..6fbee91d9e 100644
@@ -43,26 +43,6 @@ Currently supported by DPDK:
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA_EVENTDEV`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_dpaa_event`` driver.
-
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA EVENTDEV PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/eventdevs/dpaa2.rst +0 -20
index 835767f98d..b992ae649e 100644
@@ -52,26 +52,6 @@ Currently supported by DPDK:
 Pre-Installation Configuration
 ------------------------------
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_EVENTDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_dpaa2_event`` driver.
-
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA2 EVENTDEV PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/eventdevs/octeontx.rst +0 -24
index 9a3646db0d..f7a4cdd586 100644
@@ -41,30 +41,6 @@ Prerequisites
 
 See :doc:`../platform/octeontx` for setup information.
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-Please note that enabling debugging options may affect system performance.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_SSOVF`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_octeontx_ssovf`` driver.
-
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the OCTEON TX SSOVF PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-thunderx-linux-gcc install
-
 
 Initialization
 --------------
doc/guides/eventdevs/octeontx2.rst +0 -8
index 6502f6415f..7f9eceb01f 100644
@@ -47,14 +47,6 @@ Prerequisites and Compilation procedure
 Pre-Installation Configuration
 ------------------------------
 
-Compile time Config Options
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The following option can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_EVENTDEV`` (default ``y``)
-
-  Toggle compilation of the ``librte_pmd_octeontx2_event`` driver.
 
 Runtime Config Options
 ~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.17.1
#238 lore raw

PATCH v5 15/20 doc: remove references to make from rawdevs guides

In reply to Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/rawdevs/dpaa2_cmdif.rst   | 21 ---------------------
 doc/guides/rawdevs/dpaa2_qdma.rst    | 21 ---------------------
 doc/guides/rawdevs/ifpga.rst         | 10 ----------
 doc/guides/rawdevs/ioat.rst          |  8 +-------
 doc/guides/rawdevs/ntb.rst           |  6 ------
 doc/guides/rawdevs/octeontx2_dma.rst | 12 ------------
 doc/guides/rawdevs/octeontx2_ep.rst  |  8 --------
 7 files changed, 1 insertion(+), 85 deletions(-)
doc/guides/rawdevs/dpaa2_cmdif.rst +0 -21
index be9805874b..7ac3963938 100644
@@ -44,17 +44,6 @@ Currently supported by DPDK:
    Some part of fslmc bus code (mc flib - object library) routines are
    dual licensed (BSD & GPLv2).
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_CMDIF_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_dpaa2_cmdif`` driver.
 
 Enabling logs
 -------------
@@ -68,16 +57,6 @@ For enabling logs, use the following EAL parameter:
 Using ``pmd.raw.dpaa2.cmdif`` as log matching criteria, all Event PMD logs can be
 enabled which are lower than logging ``level``.
 
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA2 CMDIF PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/rawdevs/dpaa2_qdma.rst +0 -21
index 129e83d5ef..92921fafdd 100644
@@ -48,17 +48,6 @@ Currently supported by DPDK:
    Some part of fslmc bus code (mc flib - object library) routines are
    dual licensed (BSD & GPLv2).
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_QDMA_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_dpaa2_qdma`` driver.
 
 Enabling logs
 -------------
@@ -72,16 +61,6 @@ For enabling logs, use the following EAL parameter:
 Using ``pmd.raw.dpaa2.qdma`` as log matching criteria, all Event PMD logs can be
 enabled which are lower than logging ``level``.
 
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA2 QDMA PMD for Linux arm64 gcc target, run the
-following ``make`` command:
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/rawdevs/ifpga.rst +0 -10
index a3d92a62ea..dbd0d6e37d 100644
@@ -76,16 +76,6 @@ summarized by the following block diagram::
      |        vdev_ifpga_cfg driver       |        |  Intel FpgaDev  |
      +------------------------------------+        +-----------------+
 
-Build options
--------------
-
-- ``CONFIG_RTE_LIBRTE_IFPGA_BUS`` (default ``y``)
-
-   Toggle compilation of IFPGA Bus library.
-
-- ``CONFIG_RTE_LIBRTE_IFPGA_RAWDEV`` (default ``y``)
-
-   Toggle compilation of the ``ifpga_rawdev`` driver.
 
 Run-time parameters
 -------------------
doc/guides/rawdevs/ioat.rst +1 -7
index c46460ff45..b1b10c7fad 100644
@@ -54,13 +54,7 @@ shows:
 Compilation
 ------------
 
-For builds done with ``make``, the driver compilation is enabled by the
-``CONFIG_RTE_LIBRTE_PMD_IOAT_RAWDEV`` build configuration option. This is
-enabled by default in builds for x86 platforms, and disabled in other
-configurations.
-
-For builds using ``meson`` and ``ninja``, the driver will be built when the
-target platform is x86-based.
+The driver will be built when the target platform is x86-based.
 
 Device Setup
 -------------
doc/guides/rawdevs/ntb.rst +0 -6
index aa7d809649..0589b70087 100644
@@ -30,12 +30,6 @@ is https://www.intel.com/content/dam/support/us/en/documents/server-products/Int
 - Disable PCIe PII SSC (Spread Spectrum Clocking) for both hosts. This
   is a hardware requirement.
 
-Build Options
--------------
-
-- ``CONFIG_RTE_LIBRTE_PMD_NTB_RAWDEV`` (default ``y``)
-
-   Toggle compilation of the ``ntb`` driver.
 
 Device Setup
 ------------
doc/guides/rawdevs/octeontx2_dma.rst +0 -12
index 4a9794489e..6887da5278 100644
@@ -26,18 +26,6 @@ Prerequisites and Compilation procedure
    See :doc:`../platform/octeontx2` for setup information.
 
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_DMA_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_octeontx2_dma`` driver.
-
 Enabling logs
 -------------
 
doc/guides/rawdevs/octeontx2_ep.rst +0 -8
index b03fcf789a..fb9d346ccf 100644
@@ -18,14 +18,6 @@ This OCTEON TX2 End Point mode PMD supports
 
 #. Packet Output - OCTEON TX2 to Host with info pointer mode.
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_EP_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_octeontx2_ep`` driver.
 
 Initialization
 --------------
Signature · 1 line
2.17.1
Acked-by on v5 15/20
#239 lore raw

Re: [dpdk-dev] [PATCH v5 15/20] doc: remove references to make from rawdevs guides

Quoted 15 lines · Ciara Power

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/rawdevs/dpaa2_cmdif.rst   | 21 ---------------------
 doc/guides/rawdevs/dpaa2_qdma.rst    | 21 ---------------------
 doc/guides/rawdevs/ifpga.rst         | 10 ----------
 doc/guides/rawdevs/ioat.rst          |  8 +-------
 doc/guides/rawdevs/ntb.rst           |  6 ------
 doc/guides/rawdevs/octeontx2_dma.rst | 12 ------------
 doc/guides/rawdevs/octeontx2_ep.rst  |  8 --------
 7 files changed, 1 insertion(+), 85 deletions(-)

<snip>

Quoted 7 lines
doc/guides/rawdevs/ioat.rst +0 -0
index c46460ff45..b1b10c7fad 100644
@@ -54,13 +54,7 @@ shows:
 Compilation
 ------------

doc/guides/rawdevs/ioat.rst shows: · line 58

Quoted 10 lines
doc/guides/rawdevs/ioat.rst +1 -7
 
-For builds done with ``make``, the driver compilation is enabled by the
-``CONFIG_RTE_LIBRTE_PMD_IOAT_RAWDEV`` build configuration option. This is
-enabled by default in builds for x86 platforms, and disabled in other
-configurations.
-
-For builds using ``meson`` and ``ninja``, the driver will be built when the
-target platform is x86-based.
+The driver will be built when the target platform is x86-based.
 

This change for ioat is good, but the sentence now feels a little incomplete. Can we perhaps just add on a bit to make it something like:

"The driver will be enabled in the DPDK build when the target platform is x86-based; no additional build configuration steps are necessary."

Otherwise for the ioat part:

Acked-by on v5 15/20
#240 lore raw

Re: [dpdk-dev] [PATCH v5 15/20] doc: remove references to make from rawdevs guides

In reply to Ciara Power

Hi,

Quoted 213 lines

-----Original Message-----
From: Power, Ciara <[email protected]>
Sent: Monday, September 21, 2020 21:59
To: [email protected]
Cc: Power, Ciara <[email protected]>; Nipun Gupta <[email protected]>; Mcnamara, John <[email protected]>; Kovacevic, Marko <[email protected]>; Xu, Rosen <[email protected]>; Zhang, Tianfei <[email protected]>; Richardson, Bruce <[email protected]>; Li, Xiaoyun <[email protected]>; Wu, Jingjing <[email protected]>; Satha Rao <[email protected]>; Mahipal Challa <[email protected]>
Subject: [PATCH v5 15/20] doc: remove references to make from rawdevs guides

Make is no longer supported for compiling DPDK, references are now removed in the documentation.

---
 doc/guides/rawdevs/dpaa2_cmdif.rst   | 21 ---------------------
 doc/guides/rawdevs/dpaa2_qdma.rst    | 21 ---------------------
 doc/guides/rawdevs/ifpga.rst         | 10 ----------
 doc/guides/rawdevs/ioat.rst          |  8 +-------
 doc/guides/rawdevs/ntb.rst           |  6 ------
 doc/guides/rawdevs/octeontx2_dma.rst | 12 ------------
doc/guides/rawdevs/octeontx2_ep.rst  |  8 --------
 7 files changed, 1 insertion(+), 85 deletions(-)
doc/guides/rawdevs/dpaa2_cmdif.rst +0 -11
index be9805874b..7ac3963938 100644
@@ -44,17 +44,6 @@ Currently supported by DPDK:
    Some part of fslmc bus code (mc flib - object library) routines are
    dual licensed (BSD & GPLv2).
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_CMDIF_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_dpaa2_cmdif`` driver.
 
 Enabling logs
 -------------
@@ -68,16 +57,6 @@ For enabling logs, use the following EAL parameter:
 Using ``pmd.raw.dpaa2.cmdif`` as log matching criteria, all Event PMD logs

can be enabled which are lower than logging ``level``.

doc/guides/rawdevs/dpaa2_cmdif.rst +0 -4
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA2 CMDIF PMD for Linux arm64 gcc target, run the -

following ``make`` command:

doc/guides/rawdevs/dpaa2_cmdif.rst +0 -5
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/rawdevs/dpaa2_qdma.rst +0 -11
index 129e83d5ef..92921fafdd 100644
@@ -48,17 +48,6 @@ Currently supported by DPDK:
    Some part of fslmc bus code (mc flib - object library) routines are
    dual licensed (BSD & GPLv2).
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_DPAA2_QDMA_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_dpaa2_qdma`` driver.
 
 Enabling logs
 -------------
@@ -72,16 +61,6 @@ For enabling logs, use the following EAL parameter:
 Using ``pmd.raw.dpaa2.qdma`` as log matching criteria, all Event PMD logs

can be enabled which are lower than logging ``level``.

doc/guides/rawdevs/dpaa2_qdma.rst +0 -4
-Driver Compilation
-~~~~~~~~~~~~~~~~~~
-
-To compile the DPAA2 QDMA PMD for Linux arm64 gcc target, run the -

following ``make`` command:

doc/guides/rawdevs/dpaa2_qdma.rst +0 -5
-
-.. code-block:: console
-
-   cd <DPDK-source-directory>
-   make config T=arm64-dpaa-linux-gcc install
 
 Initialization
 --------------
doc/guides/rawdevs/ifpga.rst +0 -10
index a3d92a62ea..dbd0d6e37d 100644
@@ -76,16 +76,6 @@ summarized by the following block diagram::
      |        vdev_ifpga_cfg driver       |        |  Intel FpgaDev  |
      +------------------------------------+        +-----------------+
 
-Build options
--------------
-
-- ``CONFIG_RTE_LIBRTE_IFPGA_BUS`` (default ``y``)
-
-   Toggle compilation of IFPGA Bus library.
-
-- ``CONFIG_RTE_LIBRTE_IFPGA_RAWDEV`` (default ``y``)
-
-   Toggle compilation of the ``ifpga_rawdev`` driver.
 
 Run-time parameters
 -------------------
doc/guides/rawdevs/ioat.rst index renamed from doc/guides/rawdevs/ioat.rst +0 -0

c46460ff45..b1b10c7fad 100644

doc/guides/rawdevs/ioat.rst +0 -1
@@ -54,13 +54,7 @@ shows:
 Compilation
 ------------
 
-For builds done with ``make``, the driver compilation is enabled by the -

``CONFIG_RTE_LIBRTE_PMD_IOAT_RAWDEV`` build configuration option. This is -enabled by default in builds for x86 platforms, and disabled in other - configurations.

doc/guides/rawdevs/ioat.rst +0 -2
-
-For builds using ``meson`` and ``ninja``, the driver will be built when the -

target platform is x86-based.

doc/guides/rawdevs/ioat.rst +1 -0
+The driver will be built when the target platform is x86-based.
 
 Device Setup
 -------------
doc/guides/rawdevs/ntb.rst index renamed from doc/guides/rawdevs/ntb.rst +0 -0

aa7d809649..0589b70087 100644

doc/guides/rawdevs/ntb.rst +0 -0
@@ -30,12 +30,6 @@ is

https://www.intel.com/content/dam/support/us/en/documents/server-
products/Int
- Disable PCIe PII SSC (Spread Spectrum Clocking) for both hosts. This is a hardware requirement.

doc/guides/rawdevs/ntb.rst +0 -6
-Build Options
--------------
-
-- ``CONFIG_RTE_LIBRTE_PMD_NTB_RAWDEV`` (default ``y``)
-
-   Toggle compilation of the ``ntb`` driver.
 
 Device Setup
 ------------
doc/guides/rawdevs/octeontx2_dma.rst +0 -12
index 4a9794489e..6887da5278 100644
@@ -26,18 +26,6 @@ Prerequisites and Compilation procedure
    See :doc:`../platform/octeontx2` for setup information.
 
 
-Pre-Installation Configuration
-------------------------------
-
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_DMA_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_octeontx2_dma`` driver.
-
 Enabling logs
 -------------
 
doc/guides/rawdevs/octeontx2_ep.rst +0 -9
index b03fcf789a..fb9d346ccf 100644
@@ -18,14 +18,6 @@ This OCTEON TX2 End Point mode PMD supports
 
 #. Packet Output - OCTEON TX2 to Host with info pointer mode.
 
-Config File Options
-~~~~~~~~~~~~~~~~~~~
-
-The following options can be modified in the ``config`` file.
-
-- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX2_EP_RAWDEV`` (default ``y``)
-
-  Toggle compilation of the ``lrte_pmd_octeontx2_ep`` driver.
 
 Initialization
 --------------
--
Quoted 1 line

2.17.1