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.po...@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/build_sample_apps.rst
> b/doc/guides/linux_gsg/build_sample_apps.rst
> index 2f606535c3..afa94acbbe 100644
> --- a/doc/guides/linux_gsg/build_sample_apps.rst
> +++ b/doc/guides/linux_gsg/build_sample_apps.rst
> @@ -18,14 +18,8 @@ Compiling a Sample Application
> Once an DPDK target environment directory has been created (such as
> ``x86_64-native-linux-gcc``),
> it contains all libraries and header files required to build an application.
>
This reference to x86_64-native-linuxapp-gcc is also a make-build
reference. It should be removed.
In fact, since building example apps separately is covered in section
3.2.3, I think we can rename this whole section from "compiling and running
sample applications" to just "running sample applications". Rather than
renumbering the sections and heading levels, section 6.1 can be kept just
referring back to 3.2.3, since that info may well be useful to the reader
who starts on this section.
> -When compiling an application in the Linux* environment on the DPDK, the
> following variables must be exported:
> -
> -* ``RTE_SDK`` - Points to the DPDK installation directory.
> -
> -* ``RTE_TARGET`` - Points to the DPDK target environment directory.
> -
> The following is an example of creating the ``helloworld`` application,
> which runs in the DPDK Linux environment.
> -This example may be found in the ``${RTE_SDK}/examples`` directory.
> +This example may be found in the ``${DPDK installation directory}/examples``
> directory.
>
> The directory contains the ``main.c`` file. This file, when combined with
> the libraries in the DPDK target environment,
> calls the various functions to initialize the DPDK environment,
> @@ -35,8 +29,6 @@ By default, the binary is generated in the build directory.
> .. code-block:: console
>
> cd examples/helloworld/
> - export RTE_SDK=$HOME/DPDK
> - export RTE_TARGET=x86_64-native-linux-gcc
>
> make
> CC main.o
> @@ -55,10 +47,8 @@ By default, the binary is generated in the build directory.
>
> .. code-block:: console
>
> - export RTE_SDK=/home/user/DPDK
> - cp -r $(RTE_SDK)/examples/helloworld my_rte_app
> + cp -r $(DPDK installation directory)/examples/helloworld my_rte_app
> cd my_rte_app/
> - export RTE_TARGET=x86_64-native-linux-gcc
>
> make
> CC main.o
Drop all this text and refer to previous chapter.
> @@ -232,7 +222,7 @@ If the DPDK cannot allocate enough memory on each socket,
> the EAL initialization
> Additional Sample Applications
> ------------------------------
>
> -Additional sample applications are included in the ${RTE_SDK}/examples
> directory.
> +Additional sample applications are included in the ${DPDK installation
> directory}/examples directory.
I think "${DPDK installation directory}/examples" can be written simply as
"DPDK examples" to make it a plain sentence without any explicit path
references.
> These sample applications may be built and run in a manner similar to that
> described in earlier sections in this manual.
> In addition, see the *DPDK Sample Applications User Guide* for a description
> of the application,
> specific instructions on compilation and execution and some explanation of
> the code.
The subsection on "Additonal Test Applications" following this block seems
very out of date, and should be removed IMHO.
