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 3AA20A04B5; Thu, 1 Oct 2020 00:09:18 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 9AD3F1D58D; Thu, 1 Oct 2020 00:09:16 +0200 (CEST) Received: from out2-smtp.messagingengine.com (out2-smtp.messagingengine.com [66.111.4.26]) by dpdk.org (Postfix) with ESMTP id 5ECC41D42B for ; Thu, 1 Oct 2020 00:09:14 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 55CA05C0136; Wed, 30 Sep 2020 18:09:10 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute1.internal (MEProxy); Wed, 30 Sep 2020 18:09:10 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=fm2; bh= 7yT0f91o84m7TiEcLK40ZfbSWSGEhxyuLHqkYtKbYfo=; b=BPDf1Jr+k8OR9TtS Lf+uLa7emEPh4keCFnCpAt6o9CJWXQkJQVM9XvaW+Be8IwIX54NIivYCw0raLjJy +Uw8tyHLT96KYdimmt0Mw+3O44ILYHop0Q83qI7m0/venjRsXuyzqzMkexto4ZBv 9hyEL5A+Qglo2otNvP7jtIWc4qgdklW8uGgb5kcP7ADgYDdbGjpwiBlFgCtPBcdV 9BansXTyP455Skza93m56Nn1xFEe7R9pUS2IC74RQQtFS959YtOdr4dzda3jI4sn jODv6KE9nrSrNZCgTnYA1ICwvapHbhtMKVbtxc6gOHeNvIDEfZ3lSHaGwIjqo4Sw AQ7/2g== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm3; bh=7yT0f91o84m7TiEcLK40ZfbSWSGEhxyuLHqkYtKbY fo=; b=XHbUN+VbReec/v5RsEzJhi0Wm+xe9X7DIUNW7Z8R9RGpGKqA9QzWmR4n/ ADESl7CEToeqlNTVlNC5f/53CK3bhGX+rKwfDJrz9v8QJDNpGryCFtDWgYjS18oo C6InPcLK2xnLb/pr+bqv+dq1AJyGopwM/tyD7KDVixz5XwFAS4nMLry1oeIZx+Wk 3dB+oy1aC6Q059o1XPuOPgtYDRYmDqtjGMafimk6+zAabMYvpyWsjQlHnnzu2e67 PpMxP6S4TgVIhu8092VlD/M20R14Bhsg/pzWqcDy25pyqY5tdBfC7s8ztBSObbo3 vQ3rYhP5T0mr77MBswuAiYR2Sq5Jw== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedujedrfeefgddtjecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvffufffkjghfggfgtgesthhqredttddtudenucfhrhhomhepvfhhohhmrghs ucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenucggtf frrghtthgvrhhnpeehffdujeeifeduvdelleelgeetheevudehheevtdeggfeihfejleej teekgfdvieenucffohhmrghinheptddvrddqthhopddtvddrthhonecukfhppeejjedrud efgedrvddtfedrudekgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgr ihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 3EA88328005E; Wed, 30 Sep 2020 18:09:09 -0400 (EDT) From: Thomas Monjalon To: Ciara Power Cc: dev@dpdk.org, John McNamara , Marko Kovacevic Date: Thu, 01 Oct 2020 00:09:07 +0200 Message-ID: <3051248.mg5JyDbmDi@thomas> In-Reply-To: <20200921135931.13355-4-ciara.power@intel.com> References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> <20200921135931.13355-4-ciara.power@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="iso-8859-1" Subject: Re: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide 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" Hi, Below are some comments. If you agree, I will do the changes myself while pushing to the main branch. 21/09/2020 15:59, Ciara Power: > Make is no longer supported for compiling DPDK, references are now > removed in the documentation. >=20 > Signed-off-by: Ciara Power > Reviewed-by: Bruce Richardson > --- > doc/guides/linux_gsg/build_dpdk.rst | 16 +++++++++++----- > doc/guides/linux_gsg/build_sample_apps.rst | 18 +++--------------- > doc/guides/linux_gsg/enable_func.rst | 13 +++++-------- > doc/guides/linux_gsg/linux_drivers.rst | 18 +++++++++++------- > doc/guides/linux_gsg/sys_reqs.rst | 6 +----- > 5 files changed, 31 insertions(+), 40 deletions(-) >=20 > diff --git a/doc/guides/linux_gsg/build_dpdk.rst b/doc/guides/linux_gsg/b= uild_dpdk.rst > index a895e1b0f4..85d04520bf 100644 > --- a/doc/guides/linux_gsg/build_dpdk.rst > +++ b/doc/guides/linux_gsg/build_dpdk.rst > @@ -76,6 +76,8 @@ and the last step causing the dynamic loader `ld.so` to= update its cache to take > distributions, `/usr/local/lib` and `/usr/local/lib64` should be added > to a file in `/etc/ld.so.conf.d/` before running `ldconfig`. > =20 > +.. _adjusting_build_options: > + extra blank line > =20 > Adjusting Build Options > ~~~~~~~~~~~~~~~~~~~~~~~ > @@ -112,6 +114,9 @@ dependencies are met on the current system are built. > When `-Dexamples=3Dall` is set as a meson option, meson will check each = example application to see if it can be built, > and add all which can be built to the list of tasks in the ninja build c= onfiguration file. > =20 > +.. _building_app_using_installed_dpdk: > + > + extra blank line > Building Applications Using Installed DPDK > ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > =20 > @@ -135,11 +140,12 @@ and the sources for that build are stored in ``$(SR= CS-y)``. > =20 > .. note:: > =20 > - Unlike with the older make build system, the meson system is not > - designed to be used directly from a build directory. Instead it is > - recommended that it be installed either system-wide or to a known > - location in the user's home directory. The install location can be set > - using the `--prefix` meson option (default: `/usr/local`). > + Unlike with the make build system present used in older DPDK releases, > + the meson system is not designed to be used directly from a build > + directory. Instead it is recommended that it be installed either > + system-wide or to a known location in the user's home directory. > + The install location can be set using the `--prefix` meson option > + (default: `/usr/local`). I prefer the first version. The words "system present used" look weird. Anyway, if any reword is needed, better to change only the impacted line and keep the rest of the line wrapping untouched. > =20 > an equivalent build recipe for a simple DPDK application using meson as a > build system is shown below: > diff --git a/doc/guides/linux_gsg/build_sample_apps.rst b/doc/guides/linu= x_gsg/build_sample_apps.rst > index 2882883f95..f4bf0e71e5 100644 > --- a/doc/guides/linux_gsg/build_sample_apps.rst > +++ b/doc/guides/linux_gsg/build_sample_apps.rst > @@ -1,7 +1,7 @@ > .. SPDX-License-Identifier: BSD-3-Clause > Copyright(c) 2010-2014 Intel Corporation. > =20 > -Compiling and Running Sample Applications > +Running Sample Applications > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D Underlining must be adjusted > =20 > The chapter describes how to compile and run applications in an DPDK env= ironment. > @@ -119,7 +119,7 @@ Copy the DPDK application binary to your target, then= run the application as fol > (assuming the platform has four memory channels per processor socket, > and that cores 0-3 are present and are to be used for running the applic= ation):: > =20 > - ./helloworld -l 0-3 -n 4 > + ./dpdk-helloworld -l 0-3 -n 4 > =20 > .. note:: > =20 > @@ -183,19 +183,7 @@ If the DPDK cannot allocate enough memory on each so= cket, the EAL initialization > Additional Sample Applications > ------------------------------ > =20 > -Additional sample applications are included in the ${RTE_SDK}/examples d= irectory. > +Additional sample applications are included in the DPDK examples directo= ry. > These sample applications may be built and run in a manner similar to th= at described in earlier sections in this manual. > In addition, see the *DPDK Sample Applications User Guide* for a descrip= tion of the application, > specific instructions on compilation and execution and some explanation = of the code. > - > -Additional Test Applications > ----------------------------- > - > -In addition, there are two other applications that are built when the li= braries are created. > -The source files for these are in the DPDK/app directory and are called = test and testpmd. > -Once the libraries are created, they can be found in the build/app direc= tory. > - > -* The test application provides a variety of specific tests for the va= rious functions in the DPDK. > - > -* The testpmd application provides a number of different packet throug= hput tests and > - examples of features such as how to use the Flow Director found in t= he Intel=AE 82599 10 Gigabit Ethernet Controller. OK to remove the test applications from the page dedicated to samples. A lot of similar cleanup could be done if someone volunteers. > --- a/doc/guides/linux_gsg/enable_func.rst > +++ b/doc/guides/linux_gsg/enable_func.rst [...] > @@ -128,13 +130,8 @@ Loading the DPDK KNI Kernel Module > ---------------------------------- > =20 > To run the DPDK Kernel NIC Interface (KNI) sample application, an extra = kernel module (the kni module) must be loaded into the running kernel. > -The module is found in the kmod sub-directory of the DPDK target directo= ry. > -Similar to the loading of the ``igb_uio`` module, this module should be = loaded using the insmod command as shown below > -(assuming that the current directory is the DPDK target directory): > - > -.. code-block:: console > - > - insmod kmod/rte_kni.ko > +The module is found in the kernel/linux sub-directory of the DPDK build = directory. > +This can be enabled in the same way as the ``igb_uio`` module, please se= e :ref:`load_uio` for details. The only relevant info in "load_uio" chapter is to use insmod. I think it is better to keep some lines above: It should be loaded using the insmod command:: insmod kmod/rte_kni.ko > --- a/doc/guides/linux_gsg/linux_drivers.rst > +++ b/doc/guides/linux_gsg/linux_drivers.rst > @@ -12,6 +12,9 @@ Different PMDs may require different kernel drivers in = order to work properly. > Depends on the PMD being used, a corresponding kernel driver should be l= oad > and bind to the network ports. > =20 > +.. _load_uio: > + > + This anchor is not need in my opinion. > UIO > --- > =20 > @@ -28,19 +31,20 @@ can provide the uio capability. This module can be lo= aded using the command: > ``uio_pci_generic`` module doesn't support the creation of virtual f= unctions. > =20 > As an alternative to the ``uio_pci_generic``, the DPDK also includes the= igb_uio > -module which can be found in the kmod subdirectory referred to above. It= can > +module which can be found in the kernel/linux subdirectory referred to a= bove. It can > be loaded as shown below: > =20 > .. code-block:: console > =20 > sudo modprobe uio > - sudo insmod kmod/igb_uio.ko > + sudo insmod /kernel/linux/igb_uio/igb_uio.ko > =20 > .. note:: > =20 > - ``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 e= nabled. > - It is planned to move ``igb_uio`` module to a different git repositor= y. > + Building DPDK Linux kernel modules is disabled by default starting fr= om DPDK v20.02. > + To enable them again, the config option "enable_kmods" needs to be se= t in the meson > + build configuration. See :ref:`adjusting_build_options` for details o= n how to set/clear > + build options. It is planned to move ``igb_uio`` module to a differen= t git repository. In general it is better to split the lines logically to ease future patches= diff.