[20.11,06/19] doc: remove references to make in compressdev guides

Message ID 20200807123009.21266-7-ciara.power@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series remove make support in DPDK |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Power, Ciara Aug. 7, 2020, 12:29 p.m. UTC
  Make is no longer supported for compiling DPDK, references are now
removed in the documentation.

Signed-off-by: Ciara Power <ciara.power@intel.com>
---
 doc/guides/compressdevs/isal.rst     |  4 ----
 doc/guides/compressdevs/octeontx.rst | 16 ----------------
 doc/guides/compressdevs/zlib.rst     |  4 ----
 3 files changed, 24 deletions(-)
  

Comments

Kevin Laatz Aug. 18, 2020, 11:46 a.m. UTC | #1
On 07/08/2020 13:29, 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@intel.com>
> ---
>   doc/guides/compressdevs/isal.rst     |  4 ----
>   doc/guides/compressdevs/octeontx.rst | 16 ----------------
>   doc/guides/compressdevs/zlib.rst     |  4 ----
>   3 files changed, 24 deletions(-)
<snip>
> diff --git a/doc/guides/compressdevs/octeontx.rst b/doc/guides/compressdevs/octeontx.rst
> index 5924ad1fa3..62585847d6 100644
> --- a/doc/guides/compressdevs/octeontx.rst
> +++ b/doc/guides/compressdevs/octeontx.rst
> @@ -59,18 +59,6 @@ Steps To Setup Platform
>   Installation
>   ------------
>   
This section heading is no longer needed since you removed the contents 
below.
> -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 +84,6 @@ 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"
./test needs to be changed to ./dpdk-test for meson

Once the minor fixes above are made,

Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
  

Patch

diff --git a/doc/guides/compressdevs/isal.rst b/doc/guides/compressdevs/isal.rst
index af1f41f240..1d146fb4a6 100644
--- a/doc/guides/compressdevs/isal.rst
+++ b/doc/guides/compressdevs/isal.rst
@@ -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.
diff --git a/doc/guides/compressdevs/octeontx.rst b/doc/guides/compressdevs/octeontx.rst
index 5924ad1fa3..62585847d6 100644
--- a/doc/guides/compressdevs/octeontx.rst
+++ b/doc/guides/compressdevs/octeontx.rst
@@ -59,18 +59,6 @@  Steps To Setup Platform
 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 +84,6 @@  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
diff --git a/doc/guides/compressdevs/zlib.rst b/doc/guides/compressdevs/zlib.rst
index 986c59d43b..6e397ecd7e 100644
--- a/doc/guides/compressdevs/zlib.rst
+++ b/doc/guides/compressdevs/zlib.rst
@@ -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.