[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.
> 

Scanned the first half of the NIC guide with this patch applied. Some
comments below. The review of the second half of the doc will follow.

/Bruce

> Signed-off-by: Ciara Power <ciara.power at intel.com>
> ---
>  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        |  3 --
>  doc/guides/nics/cxgbe.rst       | 13 --------
>  doc/guides/nics/dpaa.rst        | 25 --------------
>  doc/guides/nics/dpaa2.rst       | 24 --------------
>  doc/guides/nics/ena.rst         | 16 ---------
>  doc/guides/nics/enic.rst        |  9 -----
>  doc/guides/nics/fail_safe.rst   | 12 -------
>  doc/guides/nics/fm10k.rst       |  4 ---
>  doc/guides/nics/hinic.rst       |  9 -----
>  doc/guides/nics/hns3.rst        | 10 ------
>  doc/guides/nics/i40e.rst        | 28 ++--------------
>  doc/guides/nics/ice.rst         | 17 ----------
>  doc/guides/nics/igc.rst         | 14 --------
>  doc/guides/nics/intel_vf.rst    | 14 ++------
>  doc/guides/nics/ionic.rst       |  8 -----
>  doc/guides/nics/ipn3ke.rst      |  8 -----
>  doc/guides/nics/liquidio.rst    | 27 ---------------
>  doc/guides/nics/mlx4.rst        | 51 -----------------------------
>  doc/guides/nics/mlx5.rst        | 58 ---------------------------------
>  doc/guides/nics/mvneta.rst      | 19 +----------
>  doc/guides/nics/mvpp2.rst       | 29 +----------------
>  doc/guides/nics/nfb.rst         | 17 +---------
>  doc/guides/nics/nfp.rst         |  4 ---
>  doc/guides/nics/null.rst        |  6 ++--
>  doc/guides/nics/octeontx.rst    | 19 +----------
>  doc/guides/nics/octeontx2.rst   | 11 -------
>  doc/guides/nics/pcap_ring.rst   | 22 ++++++-------
>  doc/guides/nics/qede.rst        | 17 ++--------
>  doc/guides/nics/sfc_efx.rst     | 15 ---------
>  doc/guides/nics/softnic.rst     |  9 -----
>  doc/guides/nics/szedata2.rst    | 18 +---------
>  doc/guides/nics/thunderx.rst    | 20 ------------
>  doc/guides/nics/vdev_netvsc.rst |  6 ----
>  37 files changed, 26 insertions(+), 608 deletions(-)
> 

The features.rst file needs a small update - near the end where the
supported architectures are listed, we need to remove the "Use defconfig_*"
values. I don't think any replacement text is needed for those.

<snip>
> diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
> index 129a16cfc7..8c0d60f154 100644
> --- a/doc/guides/nics/bnxt.rst
> +++ b/doc/guides/nics/bnxt.rst
> @@ -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

There is also a reference to CONFIG_RTE_ETHDEV_QUEUE_STAT_CNTRS, which
should be changed to a reference to RTE_ETHDEV_QUEUE_STAT_CNTRS in
config/rte_config.h


> diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst
> index 54a4c13899..628e8063c2 100644
> --- a/doc/guides/nics/cxgbe.rst
> +++ b/doc/guides/nics/cxgbe.rst
> @@ -90,19 +90,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_CXGBE_PMD`` (default **y**)
> -
> -  Toggle compilation of librte_pmd_cxgbe driver.
> -
> -  .. note::
> -
> -     This controls compilation of both CXGBE and CXGBEVF PMD.
>  
>  Runtime Options

The level headings of this section are now wrong. I think the heading
"Pre-Installation Configuration" should be removed and the "Runtime
Options" subsection promoted up a level.

<snip>
> diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
> index b7430f6c4e..19f0b06885 100644
> --- a/doc/guides/nics/i40e.rst
> +++ b/doc/guides/nics/i40e.rst
> @@ -156,34 +156,12 @@ Config File Options
>  ~~~~~~~~~~~~~~~~~~~
>  
>  The following options can be modified in the ``config`` file.

The "config" file should be clarified as "config/rte_config.h". However,
I'd query if the values in that file actually need to be called out as
tunable in the documentation. Can you please check with the i40e
maintainers if they can be dropped here.

> -Please note that enabling debugging options may affect system performance.
>  
> -- ``CONFIG_RTE_LIBRTE_I40E_PMD`` (default ``y``)
> -
> -  Toggle compilation of the ``librte_pmd_i40e`` driver.
> -
> -- ``CONFIG_RTE_LIBRTE_I40E_DEBUG_*`` (default ``n``)
> -
> -  Toggle display of generic debugging messages.
> -
> -- ``CONFIG_RTE_LIBRTE_I40E_RX_ALLOW_BULK_ALLOC`` (default ``y``)
> -
> -  Toggle bulk allocation for RX.
> -
> -- ``CONFIG_RTE_LIBRTE_I40E_INC_VECTOR`` (default ``n``)
> -
> -  Toggle the use of Vector PMD instead of normal RX/TX path.
> -  To enable vPMD for RX, bulk allocation for Rx must be allowed.
> -
> -- ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` (default ``n``)
> -
> -  Toggle to use a 16-byte RX descriptor, by default the RX descriptor is 32 byte.
> -
> -- ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_PF`` (default ``64``)
> +- ``RTE_LIBRTE_I40E_QUEUE_NUM_PER_PF`` (default ``64``)
>  
>    Number of queues reserved for PF.
>  
> -- ``CONFIG_RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM`` (default ``4``)
> +- ``RTE_LIBRTE_I40E_QUEUE_NUM_PER_VM`` (default ``4``)
>  
>    Number of queues reserved for each VMDQ Pool.
>  
> @@ -760,7 +738,7 @@ Use 16 Bytes RX Descriptor Size
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
>  As i40e PMD supports both 16 and 32 bytes RX descriptor sizes, and 16 bytes size can provide helps to high performance of small packets.
> -Configuration of ``CONFIG_RTE_LIBRTE_I40E_16BYTE_RX_DESC`` in config files can be changed to use 16 bytes size RX descriptors.
> +Configuration of ``RTE_LIBRTE_I40E_16BYTE_RX_DESC`` in config files can be changed to use 16 bytes size RX descriptors.

This needs more clarification - the setting should be added as "#define
RTE_... 1" in config/rte_config.h.

Actually, unrelated to this set, a future patch should remove the #undef in
the config/rte_config.h file, so that we can set the flag just using
CFLAGS.

>  
>  Input set requirement of each pctype for FDIR
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
<snip>
> diff --git a/doc/guides/nics/intel_vf.rst b/doc/guides/nics/intel_vf.rst
> index ade5152595..6a8fe0f02c 100644
> --- a/doc/guides/nics/intel_vf.rst
> +++ b/doc/guides/nics/intel_vf.rst
> @@ -124,7 +124,7 @@ 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 number of queue pairs of each VF can be configured by ``RTE_LIBRTE_I40E_QUEUE_NUM_PER_VF`` in ``config`` file.

This is covered previously in the i40e doc, so I'd suggest dropping this
line completely.

>  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 +521,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/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::
>  
<snip>