[dpdk-dev] [PATCH v6 11/14] doc: remove reference to make from tools guides

[Thomas Monjalon]

09/10/2020 12:21, Ciara Power:
> 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>
> Reviewed-by: Kevin Laatz <kevin.laatz at intel.com>
> Acked-by: Nicolas Chautru <nicolas.chautru at intel.com>
> 
> ---
> v6:
>   - Fixed indentation for testbbdev list entry.
> v5:
>   - Reworded sentence in pdump doc.
>   - Replaced references to testbbdev binary with dpdk-test-bbdev.
>   - Fixed links to linux_gsg doc.
> ---
>  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 ++++++++---------
>  6 files changed, 32 insertions(+), 74 deletions(-)
> 
> diff --git a/doc/guides/tools/comp_perf.rst b/doc/guides/tools/comp_perf.rst
> index ee585d1024..269d7bdc9d 100644
> --- a/doc/guides/tools/comp_perf.rst
> +++ b/doc/guides/tools/comp_perf.rst
> @@ -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` for compilation steps.

Funnily there was only one step in this section.
I don't see any benefit of referencing how to compile on Linux everywhere.
I think it would be better to just drop the whole section about compilation.


>  Running the Tool
[...]
> --- a/doc/guides/tools/cryptoperf.rst
> +++ b/doc/guides/tools/cryptoperf.rst
> @@ -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` 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.

Same here, I would keep only the "Linearization setting".


> --- a/doc/guides/tools/testbbdev.rst
> +++ b/doc/guides/tools/testbbdev.rst
> @@ -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` 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.

Same here, there is no value in repeating these obvious considerations
about compilation.

[...]
> --- a/doc/guides/tools/testeventdev.rst
> +++ b/doc/guides/tools/testeventdev.rst
> @@ -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` 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.

Same here