[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(-)
> 
> diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/build_dpdk.rst
> index c536e354ef..a0536696e6 100644
> --- a/doc/guides/linux_gsg/build_dpdk.rst
> +++ b/doc/guides/linux_gsg/build_dpdk.rst
> @@ -39,11 +39,6 @@ Compiling and Installing DPDK System-wide

In the directory listing just before this "Compiling and Installing..."
subsection, you need to remove the reference to the "mk" directory.

>  DPDK can be configured, built and installed on your system using the tools
>  ``meson`` and ``ninja``.
>  
> -.. note::
> -
> -  The older makefile-based build system used in older DPDK releases is
> -  still present and its use is described in section
> -  `Installation of DPDK Target Environment using Make`_.
>  
>  DPDK Configuration
>  ~~~~~~~~~~~~~~~~~~
> @@ -158,59 +153,6 @@ build system is shown below:
>     executable('dpdk-app', sources, dependencies: dpdk)
>  

In the Note before this block, where it says that DPDK is no longer
designed for linking apps straight from the build directory, the "older
make build system" can be changed to "make build system present used in
older DPDK releases", so similar.

>  
> -Installation of DPDK Target Environment using Make
> ---------------------------------------------------
> -
> -.. note::
> -
> -   The building of DPDK using make will be deprecated in a future release. It
> -   is therefore recommended that DPDK installation is done using meson and
> -   ninja as described above.
> -
> -Get a native target environment automatically::
> -
> -   make defconfig O=mybuild
> -
> -.. note::
> -
> -    Within the configuration files, the ``RTE_MACHINE`` configuration value is set to native,
> -    which means that the compiled software is tuned for the platform on which it is built.
> -
> -Or get a specific target environment::
> -
> -   make config T=x86_64-native-linux-gcc O=mybuild
> -
> -The format of a DPDK target is "ARCH-MACHINE-EXECENV-TOOLCHAIN".
> -Available targets can be found with::
> -
> -   make help
> -
> -Customize the target configuration in the generated ``.config`` file.
> -Example for enabling the pcap PMD::
> -
> -   sed -ri 's,(PMD_PCAP=).*,\1y,' mybuild/.config
> -
> -Compile the target::
> -
> -   make -j4 O=mybuild
> -
> -.. warning::
> -
> -    Any kernel modules to be used, e.g. ``igb_uio``, ``kni``, must be compiled with the
> -    same kernel as the one running on the target.
> -    If the DPDK is not being built on the target machine,
> -    the ``RTE_KERNELDIR`` environment variable should be used to point the compilation at a copy of the kernel version to be used on the target machine.
> -
> -Install the target in a separate directory::
> -
> -   make install O=mybuild DESTDIR=myinstall prefix=
> -
> -The environment is ready to build a DPDK application::
> -
> -   RTE_SDK=$(pwd)/myinstall/share/dpdk RTE_TARGET=x86_64-native-linux-gcc make -C myapp
> -
> -In addition, the make clean command can be used to remove any existing compiled files for a subsequent full, clean rebuild of the code.
> -
>  Browsing the Installed DPDK Environment Target
>  ----------------------------------------------
>  

I think we should remove this last subsection too, because, while it
doesn't actually refer to make directly, it's more in keeping with the
target-build-dir style of the make system.