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 2D53BA04AF; Wed, 19 Aug 2020 17:21:52 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id F071E14581; Wed, 19 Aug 2020 17:21:50 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id 4E3672C02 for ; Wed, 19 Aug 2020 17:21:49 +0200 (CEST) IronPort-SDR: qfa6jcgkc845SJyxlZ1Q3VEq8gxn+KTlN4KikbCJ1wibxUrKxs0IoWCHKWDMbzk2gmuMtI7cBk FLInBQbzw+jg== X-IronPort-AV: E=McAfee;i="6000,8403,9717"; a="154394503" X-IronPort-AV: E=Sophos;i="5.76,331,1592895600"; d="scan'208";a="154394503" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga004.jf.intel.com ([10.7.209.38]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Aug 2020 08:21:48 -0700 IronPort-SDR: qYKYTqRt3k1rwb7e0BX4QRBut0AEW2aC+CdFyw9YE5rxLkjMnz/XVEDNv14zvUHbIuwKxINy9J yVytwlymi7ng== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.76,331,1592895600"; d="scan'208";a="441635696" Received: from klaatz-mobl1.ger.corp.intel.com (HELO [10.251.94.41]) ([10.251.94.41]) by orsmga004.jf.intel.com with ESMTP; 19 Aug 2020 08:21:46 -0700 To: Ciara Power , dev@dpdk.org Cc: bruce.richardson@intel.com, thomas@monjalon.net References: <20200807123009.21266-1-ciara.power@intel.com> <20200807123009.21266-17-ciara.power@intel.com> From: "Laatz, Kevin" Message-ID: <2c371132-b102-018e-2b69-824514d51d6f@intel.com> Date: Wed, 19 Aug 2020 16:21:45 +0100 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:68.0) Gecko/20100101 Thunderbird/68.11.0 MIME-Version: 1.0 In-Reply-To: <20200807123009.21266-17-ciara.power@intel.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 8bit Content-Language: en-US Subject: Re: [dpdk-dev] [PATCH 20.11 16/19] doc: remove references to make in prog 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" On 07/08/2020 13:30, Ciara Power wrote: > Make is no longer supported for compiling DPDK, references are now > removed in the documentation. > > Signed-off-by: Ciara Power > --- > doc/guides/prog_guide/build_app.rst | 46 +--- > .../prog_guide/dev_kit_build_system.rst | 218 +----------------- > .../prog_guide/dev_kit_root_make_help.rst | 188 --------------- > .../prog_guide/env_abstraction_layer.rst | 17 +- > .../prog_guide/ext_app_lib_make_help.rst | 25 +- > doc/guides/prog_guide/graph_lib.rst | 6 +- > doc/guides/prog_guide/intro.rst | 2 +- > .../prog_guide/ip_fragment_reassembly_lib.rst | 5 - > .../link_bonding_poll_mode_drv_lib.rst | 5 - > doc/guides/prog_guide/lto.rst | 13 +- > doc/guides/prog_guide/mbuf_lib.rst | 4 +- > doc/guides/prog_guide/mempool_lib.rst | 7 +- > doc/guides/prog_guide/overview.rst | 12 +- > doc/guides/prog_guide/profile_app.rst | 15 +- > doc/guides/prog_guide/qos_framework.rst | 10 +- > doc/guides/prog_guide/rcu_lib.rst | 7 +- > doc/guides/prog_guide/source_org.rst | 23 +- > doc/guides/prog_guide/trace_lib.rst | 3 +- > .../prog_guide/writing_efficient_code.rst | 3 +- > 19 files changed, 36 insertions(+), 573 deletions(-) > delete mode 100644 doc/guides/prog_guide/dev_kit_root_make_help.rst > > diff --git a/doc/guides/prog_guide/build_app.rst b/doc/guides/prog_guide/build_app.rst > index bffa55bbef..54e4283752 100644 > --- a/doc/guides/prog_guide/build_app.rst > +++ b/doc/guides/prog_guide/build_app.rst > @@ -9,14 +9,11 @@ Building Your Own Application > Compiling a Sample Application in the Development Kit Directory > --------------------------------------------------------------- > > -When compiling a sample application (for example, hello world), the following variables must be exported: > -RTE_SDK and RTE_TARGET. > +To compile a sample application (for example, hello world): > > .. code-block:: console > > ~/DPDK$ cd examples/helloworld/ > - ~/DPDK/examples/helloworld$ export RTE_SDK=/home/user/DPDK > - ~/DPDK/examples/helloworld$ export RTE_TARGET=x86_64-native-linux-gcc > ~/DPDK/examples/helloworld$ make > CC main.o > LD helloworld While the example apps will still support make, it would be good to give these examples for meson IMO. > @@ -39,8 +36,6 @@ The sample application (Hello World) can be duplicated in a new directory as a s > > ~$ cp -r DPDK/examples/helloworld my_rte_app > ~$ cd my_rte_app/ > - ~/my_rte_app$ export RTE_SDK=/home/user/DPDK > - ~/my_rte_app$ export RTE_TARGET=x86_64-native-linux-gcc > ~/my_rte_app$ make > CC main.o > LD helloworld > @@ -53,47 +48,10 @@ Customizing Makefiles > Application Makefile > ~~~~~~~~~~~~~~~~~~~~ > > -The default makefile provided with the Hello World sample application is a good starting point. It includes: > - > -* $(RTE_SDK)/mk/rte.vars.mk at the beginning > - > -* $(RTE_SDK)/mk/rte.extapp.mk at the end > +The default makefile provided with the Hello World sample application is a good starting point. > > The user must define several variables: > > * APP: Contains the name of the application. > > * SRCS-y: List of source files (\*.c, \*.S). > - > -Library Makefile > -~~~~~~~~~~~~~~~~ > - > -It is also possible to build a library in the same way: > - > -* Include $(RTE_SDK)/mk/rte.vars.mk at the beginning. > - > -* Include $(RTE_SDK)/mk/rte.extlib.mk at the end. > - > -The only difference is that APP should be replaced by LIB, which contains the name of the library. For example, libfoo.a. > - > -Customize Makefile Actions > -~~~~~~~~~~~~~~~~~~~~~~~~~~ > - > -Some variables can be defined to customize Makefile actions. The most common are listed below. Refer to > -:ref:`Makefile Description ` section in > -:ref:`Development Kit Build System ` > - > -chapter for details. > - > -* VPATH: The path list where the build system will search for sources. By default, > - RTE_SRCDIR will be included in VPATH. > - > -* CFLAGS_my_file.o: The specific flags to add for C compilation of my_file.c. > - > -* CFLAGS: The flags to use for C compilation. > - > -* LDFLAGS: The flags to use for linking. > - > -* CPPFLAGS: The flags to use to provide flags to the C preprocessor (only useful when assembling .S files) > - > -* LDLIBS: A list of libraries to link with (for example, -L /path/to/libfoo - lfoo) > diff --git a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst > index 6ac1bba649..314d4adbb8 100644 > --- a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst > +++ b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst > @@ -103,8 +103,3 @@ Debug logging and Statistics Collection > > The RTE_LIBRTE_IP_FRAG_TBL_STAT config macro controls statistics collection for the Fragment Table. > This macro is not enabled by default. > - > -The RTE_LIBRTE_IP_FRAG_DEBUG controls debug logging of IP fragments processing and reassembling. > -This macro is disabled by default. > -Note that while logging contains a lot of detailed information, > -it slows down packet processing and might cause the loss of a lot of packets. > diff --git a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst > index 2459fd243e..c376ac5f74 100644 > --- a/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst > +++ b/doc/guides/prog_guide/link_bonding_poll_mode_drv_lib.rst > @@ -25,11 +25,6 @@ The librte_pmd_bond library exports a C API which provides an API for the > creation of bonded devices as well as the configuration and management of the > bonded device and its slave devices. > > -.. note:: > - > - The Link Bonding PMD Library is enabled by default in the build > - configuration files, the library can be disabled by setting > - ``CONFIG_RTE_LIBRTE_PMD_BOND=n`` and recompiling the DPDK. Rather than removing this completely, I suggest replacing with the meson option: "-Ddisable_drivers=net/bond" There is also still a reference to RTE_TARGET on line 380 of this file. > > Link Bonding Modes Overview > --------------------------- > diff --git a/doc/guides/prog_guide/lto.rst b/doc/guides/prog_guide/lto.rst > index 277a6f1090..efa0cec4a1 100644 > --- a/doc/guides/prog_guide/lto.rst > +++ b/doc/guides/prog_guide/lto.rst > @@ -26,17 +26,8 @@ need to explicitly initialize variable in order to silence the compiler. > Please note that turning LTO on causes considerable extension of > build time. > > -When using make based build, link time optimization can be enabled for > -the whole DPDK by setting: > - > -.. code-block:: console > - > - CONFIG_RTE_ENABLE_LTO=y > - > -in config file. > - > -For the meson based build it can be enabled by setting meson built-in > -'b_lto' option: > +For the meson based build link time optimization can be enabled by setting > +meson built-in 'b_lto' option: This wording implies that there is another build system. Suggest changing to just "link time optimization can be enabled by setting +meson built-in 'b_lto' option". > > .. code-block:: console > > diff --git a/doc/guides/prog_guide/mbuf_lib.rst b/doc/guides/prog_guide/mbuf_lib.rst > index c3dbfb9221..2f190b40e4 100644 > --- a/doc/guides/prog_guide/mbuf_lib.rst > +++ b/doc/guides/prog_guide/mbuf_lib.rst > @@ -266,8 +266,8 @@ can be found in several of the sample applications, for example, the IPv4 Multic > Debug > ----- > > -In debug mode (CONFIG_RTE_MBUF_DEBUG is enabled), > -the functions of the mbuf library perform sanity checks before any operation (such as, buffer corruption, bad type, and so on). > +In debug mode, the functions of the mbuf library perform sanity checks before any operation (such as, buffer corruption, > +bad type, and so on). > > Use Cases > --------- > > diff --git a/doc/guides/prog_guide/profile_app.rst b/doc/guides/prog_guide/profile_app.rst > index e5d0e9079e..9394bb7b41 100644 > --- a/doc/guides/prog_guide/profile_app.rst > +++ b/doc/guides/prog_guide/profile_app.rst > @@ -33,14 +33,6 @@ Refer to the > for details about application profiling. > > > -Profiling with VTune > -~~~~~~~~~~~~~~~~~~~~ > - > -To allow VTune attaching to the DPDK application, reconfigure and recompile > -the DPDK with ``CONFIG_RTE_ETHDEV_RXTX_CALLBACKS`` and > -``CONFIG_RTE_ETHDEV_PROFILE_WITH_VTUNE`` enabled. > - > - > Profiling on ARM64 > ------------------ > > @@ -76,8 +68,7 @@ cycle counter for user space access by configuring the PMU from the privileged > mode (kernel space). > > By default the ``rte_rdtsc()`` implementation uses a portable ``cntvct_el0`` > -scheme. Application can choose the PMU based implementation with > -``CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU``. > +scheme. > > The example below shows the steps to configure the PMU based cycle counter on > an ARMv8 machine. > @@ -88,10 +79,6 @@ an ARMv8 machine. > cd armv8_pmu_cycle_counter_el0 > make > sudo insmod pmu_el0_cycle_counter.ko > - cd $DPDK_DIR > - make config T=arm64-armv8a-linux-gcc > - echo "CONFIG_RTE_ARM_EAL_RDTSC_USE_PMU=y" >> build/.config > - make This could be replaced with meson/ninja rather than just removing the build step. > > .. warning:: > > diff --git a/doc/guides/prog_guide/qos_framework.rst b/doc/guides/prog_guide/qos_framework.rst > index a159709450..4e4ea33ccb 100644 > --- a/doc/guides/prog_guide/qos_framework.rst > +++ b/doc/guides/prog_guide/qos_framework.rst > @@ -1525,15 +1525,7 @@ Integration with the DPDK QoS Scheduler > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > > RED functionality in the DPDK QoS scheduler is disabled by default. > -To enable it, use the DPDK configuration parameter: > - > -:: > - > - CONFIG_RTE_SCHED_RED=y > - > -This parameter must be set to y. > -The parameter is found in the build configuration files in the DPDK/config directory, > -for example, DPDK/config/common_linux. > +The parameter is found in the build configuration files in the DPDK/config directory. > RED configuration parameters are specified in the rte_red_params structure within the rte_sched_port_params structure > that is passed to the scheduler on initialization. > RED parameters are specified separately for four traffic classes and three packet colors (green, yellow and red) Comments outside the changes:      - index.rst still refers to the removed 'dev_kit_root_make_help.rst'      - 'kernel_nic_interface.rst' has insmod examples which need updated paths for meson Thanks, Kevin