[1/2] doc: update octeontx2 platform guide

Message ID 1593186965-17954-1-git-send-email-hkalra@marvell.com (mailing list archive)
State Superseded, archived
Delegated to: Jerin Jacob
Headers
Series [1/2] doc: update octeontx2 platform guide |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Harman Kalra June 26, 2020, 3:56 p.m. UTC
  Removing make build instructions from the platform guide
as building DPDK sources using 'make' will be deprecated
in future releases.

Signed-off-by: Harman Kalra <hkalra@marvell.com>
---
 doc/guides/platform/octeontx2.rst | 29 +++++------------------------
 1 file changed, 5 insertions(+), 24 deletions(-)
  

Comments

Jerin Jacob Sept. 28, 2020, 5:32 a.m. UTC | #1
On Fri, Jun 26, 2020 at 9:26 PM Harman Kalra <hkalra@marvell.com> wrote:
>
> Removing make build instructions from the platform guide
> as building DPDK sources using 'make' will be deprecated
> in future releases.

Please change the commit message as the fact that 'make' is removed now.
And please add the Fix tag to make the removal commit.

With the above change:
Acked-by: Jerin Jacob <jerinj@marvell.com>


>
> Signed-off-by: Harman Kalra <hkalra@marvell.com>
> ---
>  doc/guides/platform/octeontx2.rst | 29 +++++------------------------
>  1 file changed, 5 insertions(+), 24 deletions(-)
>
> diff --git a/doc/guides/platform/octeontx2.rst b/doc/guides/platform/octeontx2.rst
> index 13255eec5..7dd695175 100644
> --- a/doc/guides/platform/octeontx2.rst
> +++ b/doc/guides/platform/octeontx2.rst
> @@ -498,30 +498,19 @@ an x86 based platform.
>  Native Compilation
>  ~~~~~~~~~~~~~~~~~~
>
> -make build
> -^^^^^^^^^^
> +meson build
> +^^^^^^^^^^^
>
>  .. code-block:: console
>
> -        make config T=arm64-octeontx2-linux-gcc
> -        make -j
> +        meson build
> +        ninja -C build
>
>  The example applications can be compiled using the following:
>
>  .. code-block:: console
>
> -        cd <dpdk directory>
> -        export RTE_SDK=$PWD
> -        export RTE_TARGET=build
> -        cd examples/<application>
> -        make -j
> -
> -meson build
> -^^^^^^^^^^^
> -
> -.. code-block:: console
> -
> -        meson build
> +        meson build -Dexamples=<application>
>          ninja -C build
>
>  Cross Compilation
> @@ -529,14 +518,6 @@ Cross Compilation
>
>  Refer to :doc:`../linux_gsg/cross_build_dpdk_for_arm64` for generic arm64 details.
>
> -make build
> -^^^^^^^^^^
> -
> -.. code-block:: console
> -
> -        make config T=arm64-octeontx2-linux-gcc
> -        make -j CROSS=aarch64-marvell-linux-gnu- CONFIG_RTE_KNI_KMOD=n
> -
>  meson build
>  ^^^^^^^^^^^
>
> --
> 2.18.0
>
  

Patch

diff --git a/doc/guides/platform/octeontx2.rst b/doc/guides/platform/octeontx2.rst
index 13255eec5..7dd695175 100644
--- a/doc/guides/platform/octeontx2.rst
+++ b/doc/guides/platform/octeontx2.rst
@@ -498,30 +498,19 @@  an x86 based platform.
 Native Compilation
 ~~~~~~~~~~~~~~~~~~
 
-make build
-^^^^^^^^^^
+meson build
+^^^^^^^^^^^
 
 .. code-block:: console
 
-        make config T=arm64-octeontx2-linux-gcc
-        make -j
+        meson build
+        ninja -C build
 
 The example applications can be compiled using the following:
 
 .. code-block:: console
 
-        cd <dpdk directory>
-        export RTE_SDK=$PWD
-        export RTE_TARGET=build
-        cd examples/<application>
-        make -j
-
-meson build
-^^^^^^^^^^^
-
-.. code-block:: console
-
-        meson build
+        meson build -Dexamples=<application>
         ninja -C build
 
 Cross Compilation
@@ -529,14 +518,6 @@  Cross Compilation
 
 Refer to :doc:`../linux_gsg/cross_build_dpdk_for_arm64` for generic arm64 details.
 
-make build
-^^^^^^^^^^
-
-.. code-block:: console
-
-        make config T=arm64-octeontx2-linux-gcc
-        make -j CROSS=aarch64-marvell-linux-gnu- CONFIG_RTE_KNI_KMOD=n
-
 meson build
 ^^^^^^^^^^^