diff mbox series

[v5,15/20] doc: remove references to make from rawdevs guides

Message ID 20200921135931.13355-16-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 Sept. 21, 2020, 1:59 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>
Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
---
 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(-)

Comments

Bruce Richardson Oct. 1, 2020, 3:17 p.m. UTC | #1 
On Mon, Sep 21, 2020 at 02:59:26PM +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@intel.com>
> Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
> ---
>  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>
> diff --git a/doc/guides/rawdevs/ioat.rst b/doc/guides/rawdevs/ioat.rst
> index c46460ff45..b1b10c7fad 100644
> --- a/doc/guides/rawdevs/ioat.rst
> +++ b/doc/guides/rawdevs/ioat.rst
> @@ -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.
>  

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: Bruce Richardson <bruce.richardson@intel.com>
Xu, Rosen Oct. 2, 2020, 2:57 p.m. UTC | #2 
Hi,

> -----Original Message-----
> From: Power, Ciara <ciara.power@intel.com>
> Sent: Monday, September 21, 2020 21:59
> To: dev@dpdk.org
> Cc: Power, Ciara <ciara.power@intel.com>; Nipun Gupta
> <nipun.gupta@nxp.com>; Mcnamara, John <john.mcnamara@intel.com>;
> Kovacevic, Marko <marko.kovacevic@intel.com>; Xu, Rosen
> <rosen.xu@intel.com>; Zhang, Tianfei <tianfei.zhang@intel.com>;
> Richardson, Bruce <bruce.richardson@intel.com>; Li, Xiaoyun
> <xiaoyun.li@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>; Satha Rao
> <skoteshwar@marvell.com>; Mahipal Challa <mchalla@marvell.com>
> 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.
> 
> Signed-off-by: Ciara Power <ciara.power@intel.com>
> Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
> ---
>  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(-)
> 
> diff --git a/doc/guides/rawdevs/dpaa2_cmdif.rst
> b/doc/guides/rawdevs/dpaa2_cmdif.rst
> index be9805874b..7ac3963938 100644
> --- a/doc/guides/rawdevs/dpaa2_cmdif.rst
> +++ b/doc/guides/rawdevs/dpaa2_cmdif.rst
> @@ -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
>  --------------
> diff --git a/doc/guides/rawdevs/dpaa2_qdma.rst
> b/doc/guides/rawdevs/dpaa2_qdma.rst
> index 129e83d5ef..92921fafdd 100644
> --- a/doc/guides/rawdevs/dpaa2_qdma.rst
> +++ b/doc/guides/rawdevs/dpaa2_qdma.rst
> @@ -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
>  --------------
> diff --git a/doc/guides/rawdevs/ifpga.rst b/doc/guides/rawdevs/ifpga.rst
> index a3d92a62ea..dbd0d6e37d 100644
> --- a/doc/guides/rawdevs/ifpga.rst
> +++ b/doc/guides/rawdevs/ifpga.rst
> @@ -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
>  -------------------
> diff --git a/doc/guides/rawdevs/ioat.rst b/doc/guides/rawdevs/ioat.rst index
> c46460ff45..b1b10c7fad 100644
> --- a/doc/guides/rawdevs/ioat.rst
> +++ b/doc/guides/rawdevs/ioat.rst
> @@ -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
>  -------------
> diff --git a/doc/guides/rawdevs/ntb.rst b/doc/guides/rawdevs/ntb.rst index
> aa7d809649..0589b70087 100644
> --- a/doc/guides/rawdevs/ntb.rst
> +++ b/doc/guides/rawdevs/ntb.rst
> @@ -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
>  ------------
> diff --git a/doc/guides/rawdevs/octeontx2_dma.rst
> b/doc/guides/rawdevs/octeontx2_dma.rst
> index 4a9794489e..6887da5278 100644
> --- a/doc/guides/rawdevs/octeontx2_dma.rst
> +++ b/doc/guides/rawdevs/octeontx2_dma.rst
> @@ -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
>  -------------
> 
> diff --git a/doc/guides/rawdevs/octeontx2_ep.rst
> b/doc/guides/rawdevs/octeontx2_ep.rst
> index b03fcf789a..fb9d346ccf 100644
> --- a/doc/guides/rawdevs/octeontx2_ep.rst
> +++ b/doc/guides/rawdevs/octeontx2_ep.rst
> @@ -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
>  --------------
> --
> 2.17.1

Acked-by: Rosen Xu <rosen.xu@intel.com>
diff mbox series

Patch

diff --git a/doc/guides/rawdevs/dpaa2_cmdif.rst b/doc/guides/rawdevs/dpaa2_cmdif.rst
index be9805874b..7ac3963938 100644
--- a/doc/guides/rawdevs/dpaa2_cmdif.rst
+++ b/doc/guides/rawdevs/dpaa2_cmdif.rst
@@ -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
 --------------
diff --git a/doc/guides/rawdevs/dpaa2_qdma.rst b/doc/guides/rawdevs/dpaa2_qdma.rst
index 129e83d5ef..92921fafdd 100644
--- a/doc/guides/rawdevs/dpaa2_qdma.rst
+++ b/doc/guides/rawdevs/dpaa2_qdma.rst
@@ -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
 --------------
diff --git a/doc/guides/rawdevs/ifpga.rst b/doc/guides/rawdevs/ifpga.rst
index a3d92a62ea..dbd0d6e37d 100644
--- a/doc/guides/rawdevs/ifpga.rst
+++ b/doc/guides/rawdevs/ifpga.rst
@@ -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
 -------------------
diff --git a/doc/guides/rawdevs/ioat.rst b/doc/guides/rawdevs/ioat.rst
index c46460ff45..b1b10c7fad 100644
--- a/doc/guides/rawdevs/ioat.rst
+++ b/doc/guides/rawdevs/ioat.rst
@@ -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
 -------------
diff --git a/doc/guides/rawdevs/ntb.rst b/doc/guides/rawdevs/ntb.rst
index aa7d809649..0589b70087 100644
--- a/doc/guides/rawdevs/ntb.rst
+++ b/doc/guides/rawdevs/ntb.rst
@@ -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
 ------------
diff --git a/doc/guides/rawdevs/octeontx2_dma.rst b/doc/guides/rawdevs/octeontx2_dma.rst
index 4a9794489e..6887da5278 100644
--- a/doc/guides/rawdevs/octeontx2_dma.rst
+++ b/doc/guides/rawdevs/octeontx2_dma.rst
@@ -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
 -------------
 
diff --git a/doc/guides/rawdevs/octeontx2_ep.rst b/doc/guides/rawdevs/octeontx2_ep.rst
index b03fcf789a..fb9d346ccf 100644
--- a/doc/guides/rawdevs/octeontx2_ep.rst
+++ b/doc/guides/rawdevs/octeontx2_ep.rst
@@ -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
 --------------