From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 5E87CA04B1; Fri, 7 Aug 2020 14:40:59 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 723E21C12C; Fri, 7 Aug 2020 14:38:01 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id A42C51C0CA for ; Fri, 7 Aug 2020 14:37:55 +0200 (CEST) IronPort-SDR: AuxnhJPnIGJiOPldz4qe1ZN4SY1yIRttJu62eJBJdPo0z5z6dX3uzdgPtK3YC6HwmB5ZtoW2G5 eSg1YBlvvpow== X-IronPort-AV: E=McAfee;i="6000,8403,9705"; a="152298285" X-IronPort-AV: E=Sophos;i="5.75,445,1589266800"; d="scan'208";a="152298285" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga001.jf.intel.com ([10.7.209.18]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 07 Aug 2020 05:37:55 -0700 IronPort-SDR: JvqsYZtg6iKtvGfc/MUsR5cPJaqg3dOzaJutH1w43Xwol2ONdVbgbTLeeQgQcfnwLnWX4iJ1lb XejlhhLsqRbQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.75,445,1589266800"; d="scan'208";a="367914541" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by orsmga001.jf.intel.com with ESMTP; 07 Aug 2020 05:37:53 -0700 From: Ciara Power To: dev@dpdk.org Cc: bruce.richardson@intel.com, thomas@monjalon.net, Ciara Power Date: Fri, 7 Aug 2020 13:30:02 +0100 Message-Id: <20200807123009.21266-13-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200807123009.21266-1-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH 20.11 12/19] doc: remove references to make in Linux gsg guides X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Make is no longer supported for compiling DPDK, references are now removed in the documentation. Signed-off-by: Ciara Power --- 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 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) -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 ---------------------------------------------- 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. -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 @@ -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. 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. 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:: 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= 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 /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 /include" EXTRA_LDFLAGS="-L/lib -lnuma" diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst index b2bda80bb7..40c6f25a6f 100644 --- a/doc/guides/linux_gsg/enable_func.rst +++ b/doc/guides/linux_gsg/enable_func.rst @@ -40,9 +40,6 @@ requires that the ``HPET_MMAP`` kernel configuration option be enabled. Enabling HPET in the DPDK ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -By default, HPET support is disabled in the DPDK build configuration files. -To use HPET, the ``CONFIG_RTE_LIBEAL_USE_HPET`` setting should be changed to ``y``, which will enable the HPET settings at compile time. - For an application to use the ``rte_get_hpet_cycles()`` and ``rte_get_hpet_hz()`` API calls, and optionally to make the HPET the default time source for the rte_timer library, the new ``rte_eal_hpet_init()`` API call should be called at application initialization. diff --git a/doc/guides/linux_gsg/intro.rst b/doc/guides/linux_gsg/intro.rst index 94877f4ae2..890169e97f 100644 --- a/doc/guides/linux_gsg/intro.rst +++ b/doc/guides/linux_gsg/intro.rst @@ -23,7 +23,7 @@ The following is a list of DPDK documents in the suggested reading order: * The software architecture and how to use it (through examples), specifically in a Linux application (linux) environment - * The content of the DPDK, the build system (including the commands that can be used in the root DPDK Makefile to build the development kit and + * The content of the DPDK, the build system (including the commands that can be used to build the development kit and an application) and guidelines for porting an application * Optimizations used in the software and those that should be considered for new development diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst index 185074013a..ba0e45d95b 100644 --- a/doc/guides/linux_gsg/linux_drivers.rst +++ b/doc/guides/linux_gsg/linux_drivers.rst @@ -38,8 +38,6 @@ be loaded as shown below: .. note:: - ``igb_uio`` module is disabled by default starting from ``DPDK v20.02``. - To build it, the config option ``CONFIG_RTE_EAL_IGB_UIO`` should be enabled. It is planned to move ``igb_uio`` module to a different git repository. .. note:: diff --git a/doc/guides/linux_gsg/sys_reqs.rst b/doc/guides/linux_gsg/sys_reqs.rst index a124656bcb..a009f3146b 100644 --- a/doc/guides/linux_gsg/sys_reqs.rst +++ b/doc/guides/linux_gsg/sys_reqs.rst @@ -85,10 +85,6 @@ A number of DPDK components, such as libraries and poll-mode drivers (PMDs) have For DPDK builds using meson, the presence or absence of these dependencies will be automatically detected enabling or disabling the relevant components appropriately. -For builds using make, these components are disabled in the default configuration and -need to be enabled manually by changing the relevant setting to "y" in the build configuration file -i.e. the ``.config`` file in the build folder. - In each case, the relevant library development package (``-devel`` or ``-dev``) is needed to build the DPDK components. For libraries the additional dependencies include: -- 2.17.1