[dpdk-dev] [PATCH 20.11 14/19] doc: remove references to make in NIC guides

[Bruce Richardson]

On Fri, Aug 07, 2020 at 01:30:04PM +0100, Ciara Power wrote:
> Make is no longer supported for compiling DPDK, references are now
> removed in the documentation.
> 
> Signed-off-by: Ciara Power <ciara.power at intel.com>
> ---

Final comments for this review of the doc.

/Bruce

<snip>
> diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
> index 1f1e2f6c77..96c1015658 100644
> --- a/doc/guides/nics/mlx4.rst
> +++ b/doc/guides/nics/mlx4.rst
> @@ -16,11 +16,6 @@ the `Mellanox community <http://community.mellanox.com/welcome>`_.
>  There is also a `section dedicated to this poll mode driver
>  <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`_.
>  
> -.. note::
> -
> -   Due to external dependencies, this driver is disabled by default. It must
> -   be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX4_PMD=y`` and
> -   recompiling DPDK.
>  
>  Implementation details
>  ----------------------
> @@ -56,42 +51,6 @@ Configuration
>  Compilation options
>  ~~~~~~~~~~~~~~~~~~~
>  
> -These options can be modified in the ``.config`` file.
> -
> -- ``CONFIG_RTE_LIBRTE_MLX4_PMD`` (default **n**)
> -
> -  Toggle compilation of librte_pmd_mlx4 itself.
> -
> -- ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
> -
> -  Build PMD with additional code to make it loadable without hard
> -  dependencies on **libibverbs** nor **libmlx4**, 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 **libmlx4**
> -  in the PMD shared library or the executable static binary.
> -
> -- ``CONFIG_RTE_LIBRTE_MLX4_DEBUG`` (default **n**)
> -
> -  Toggle debugging code and stricter compilation flags. Enabling this option
> -  adds additional run-time checks and debugging messages at the cost of
> -  lower performance.
> -
>  This option is available in meson:

This heading needs to be reworded since the make options are now gone,
making it weird having it on it's own like that. I'd suggest changing it to
something like:

"The ibverbs libraries can be linked with this PMD in a number of ways,
configured by the "ibverbs_link" build option. This can take on the
values..."

Whatever way it is reworded, the rewording also applies to the mlx5 doc in
the next chapter too.

>  
>  - ``ibverbs_link`` can be ``static``, ``shared``, or ``dlopen``.
> @@ -104,9 +63,6 @@ Environment variables
>    A list of directories in which to search for the rdma-core "glue" plug-in,
>    separated by colons or semi-colons.
>  
> -  Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN``
> -  enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
> -  since ``LD_LIBRARY_PATH`` has no effect in this case.
>  
>  Run-time configuration
>  ~~~~~~~~~~~~~~~~~~~~~~
> @@ -245,13 +201,6 @@ Current RDMA core package and Linux kernel (recommended)
>  
>  .. _`RDMA core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
>  
> -If rdma-core libraries are built but not installed, DPDK makefile can link them,
> -thanks to these environment variables:
> -
> -   - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include``
> -   - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib``
> -   - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig``
> -
>  .. _Mellanox_OFED_as_a_fallback:
>  
>  Mellanox OFED as a fallback
<snip>
> diff --git a/doc/guides/nics/mvneta.rst b/doc/guides/nics/mvneta.rst
> index c8b00ddf22..7cd7bea499 100644
> --- a/doc/guides/nics/mvneta.rst
> +++ b/doc/guides/nics/mvneta.rst
> @@ -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
>  --------
> @@ -84,14 +78,6 @@ Prerequisites
>  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.

As in at least one other driver I spotted, if we remove the config file
options section, the whole chapter of pre-installation configuration needs
to be changed to just a chapter on runtime options.

>  
>  Runtime options
>  ~~~~~~~~~~~~~~~
> @@ -132,10 +118,7 @@ the path to the MUSDK installation directory needs to be exported.
>  .. 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
> +

The MUSDK path is now a meson option, so I'd replace all this with:

meson -Dlib_musdk_dir=/path/to/musdk build
ninja -C build

[This also applies to mvpp2.rst]

>  
<snip>
> diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst
> index 5b2f868952..cfa1b46ee2 100644
> --- a/doc/guides/nics/qede.rst
> +++ b/doc/guides/nics/qede.rst
> @@ -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 ``rte_config.h`` file.

Minor nit, let's clarify that as config/rte_config.h

>  
> -- ``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"``
<snip>
> diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst
> index b1ef9eba59..464c934add 100644
> --- a/doc/guides/nics/thunderx.rst
> +++ b/doc/guides/nics/thunderx.rst
> @@ -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
>  ------------------------------

This section has a reference to arm64-thunderx-linux-gcc which looks like a
make target, though is also a cross-file. Therefore I suggest referring to
that cross file explicitly, by saying to "use
config/arm/arm64-thunderx-linux-gcc as a meson cross-file when
cross-compiling".

> diff --git a/doc/guides/nics/vdev_netvsc.rst b/doc/guides/nics/vdev_netvsc.rst
> index d1da071187..d9f6319b9f 100644
> --- a/doc/guides/nics/vdev_netvsc.rst
> +++ b/doc/guides/nics/vdev_netvsc.rst
> @@ -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
>  -------------------
> -- 
> 2.17.1
> 

In the virtio.rst file, there is an example using the kni application. The
pathname there needs to be adjusted/removed and the binary referred to as
dpdk-kni. Similarly later in the doc, l3fwd-power should probably be
dpdk-l3fwd-power.