[dpdk-dev] [PATCH 20.11 12/19] doc: remove references to make in Linux gsg guides

[Bruce Richardson]

On Fri, Aug 07, 2020 at 01:30:02PM +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 at intel.com>
> ---
>  doc/guides/linux_gsg/build_dpdk.rst           | 58 -------------------
>  doc/guides/linux_gsg/build_sample_apps.rst    | 16 +----
>  .../linux_gsg/cross_build_dpdk_for_arm64.rst  | 42 --------------
>  doc/guides/linux_gsg/enable_func.rst          |  3 -
>  doc/guides/linux_gsg/intro.rst                |  2 +-
>  doc/guides/linux_gsg/linux_drivers.rst        |  2 -
>  doc/guides/linux_gsg/sys_reqs.rst             |  4 --
>  7 files changed, 4 insertions(+), 123 deletions(-)
> 
<snip>
> diff --git a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> index c5875a6d57..dc8e640835 100644
> --- a/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> +++ b/doc/guides/linux_gsg/cross_build_dpdk_for_arm64.rst
> @@ -99,45 +99,3 @@ command::
>  

The title of this section "Cross Compiling DPDK using Meson" should just be
renamed to "Cross Compiling DPDK".

Also, the note in the previous section 4.4 "Augment the cross
toolchain...", refers to the meson build and using CFLAGS and LDFLAGS, but
there is no actual reference to them in the meson build instructions -
instead they are discussed in the make build section. So I
think that note should have the section reference removed, i.e. finish the
note/sentence at the comma after LDFLAGS.

>  	meson arm64-build --cross-file config/arm/arm64_armv8_linux_gcc
>  	ninja -C arm64-build
> -
> -Configure and Cross Compile DPDK using Make
> --------------------------------------------
> -To configure a build, choose one of the target configurations, like arm64-dpaa-linux-gcc and arm64-thunderx-linux-gcc.
> -
> -.. code-block:: console
> -
> -   make config T=arm64-armv8a-linux-gcc
> -
> -To cross-compile, without compiling the kernel modules, use the following command:
> -
> -.. code-block:: console
> -
> -   make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n
> -
> -To cross-compile, including the kernel modules, the kernel source tree needs to be specified by setting
> -RTE_KERNELDIR:
> -
> -.. code-block:: console
> -
> -   make -j CROSS=aarch64-linux-gnu- RTE_KERNELDIR=<kernel_src_rootdir> CROSS_COMPILE=aarch64-linux-gnu-
> -
> -To compile for non-NUMA targets, without compiling the kernel modules, use the following command:
> -
> -.. code-block:: console
> -
> -   make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n CONFIG_RTE_LIBRTE_VHOST_NUMA=n CONFIG_RTE_EAL_NUMA_AWARE_HUGEPAGES=n
> -
> -.. note::
> -
> -   1. EXTRA_CFLAGS and EXTRA_LDFLAGS should be added to include the NUMA headers and link the library respectively,
> -   if the above step :ref:`augment_the_cross_toolchain_with_numa_support` was skipped therefore the toolchain was not
> -   augmented with NUMA support.
> -
> -   2. "-isystem <numa_install_dir>/include" should be add to EXTRA_CFLAGS, otherwise the numa.h file will get a lot of compiling
> -   errors of Werror=cast-qual, Werror=strict-prototypes and Werror=old-style-definition.
> -
> -   An example is given below:
> -
> -   .. code-block:: console
> -
> -      make -j CROSS=aarch64-linux-gnu- CONFIG_RTE_KNI_KMOD=n CONFIG_RTE_EAL_IGB_UIO=n EXTRA_CFLAGS="-isystem <numa_install_dir>/include" EXTRA_LDFLAGS="-L<numa_install_dir>/lib -lnuma"