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 A7141A04B5; Thu, 1 Oct 2020 10:32:03 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 20CF61D16C; Thu, 1 Oct 2020 10:32:02 +0200 (CEST) Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by dpdk.org (Postfix) with ESMTP id 7478A1D16B for ; Thu, 1 Oct 2020 10:31:59 +0200 (CEST) IronPort-SDR: e4UinXgUzKmymjO4VQCbl00Plm4AETPSYh88P71pgGg+EG59o6pXNgqkEnlnLN3tMeDLcgiRxs VNQBe1dPpS3w== X-IronPort-AV: E=McAfee;i="6000,8403,9760"; a="150450468" X-IronPort-AV: E=Sophos;i="5.77,323,1596524400"; d="scan'208";a="150450468" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga001.fm.intel.com ([10.253.24.23]) by orsmga106.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 01 Oct 2020 01:31:55 -0700 IronPort-SDR: pDfwQrc+XIk/jZDzHY+4imoNZgVTDSBPGLcNu+GdTiVIyOozugE85gMOzCdh7tfe21OGptReUB krGz7iod/t3Q== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,323,1596524400"; d="scan'208";a="415988977" Received: from fmsmsx601.amr.corp.intel.com ([10.18.126.81]) by fmsmga001.fm.intel.com with ESMTP; 01 Oct 2020 01:31:55 -0700 Received: from fmsmsx607.amr.corp.intel.com (10.18.126.87) by fmsmsx601.amr.corp.intel.com (10.18.126.81) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5; Thu, 1 Oct 2020 01:31:55 -0700 Received: from fmsmsx603.amr.corp.intel.com (10.18.126.83) by fmsmsx607.amr.corp.intel.com (10.18.126.87) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5; Thu, 1 Oct 2020 01:31:54 -0700 Received: from fmsedg601.ED.cps.intel.com (10.1.192.135) by fmsmsx603.amr.corp.intel.com (10.18.126.83) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.1713.5 via Frontend Transport; Thu, 1 Oct 2020 01:31:54 -0700 Received: from NAM10-MW2-obe.outbound.protection.outlook.com (104.47.55.100) by edgegateway.intel.com (192.55.55.70) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.1713.5; Thu, 1 Oct 2020 01:31:52 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=QN3TjQU3YyU57N0iHySBpV0u9atzcteerkYNIxO4kjyh5R0wpX1Nzm4phhjUrmt9eB9NHpdxOCWRuVa0K302RXlF42TelloY0u2du9QNsEXk55c3h4cWz9rGzvTfZFB8qbQ0crTg0XwjXshTVJEUPECQe/PCdZEE2Cupab2EStadkDOP8AGt+BacP0jhcipItFwtwzW15aL9pXF7j9pMwdQcg7j+JdSdaY+kdTw5BQ9jPb6uC3kf1bJ/4eXZ/WA9GHPkaLi4CqWHGc4Xop+1gh/7CVJ4UUFR/g5EfigHd8yDltMNAQJHZChHqYa8/Pfslgs0hoz6G0vgJJoO/fba7w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=JJpE/WraCRSYYFgqqLqF1RKUvNVooWzLu2JNZwkK9mE=; b=nTspdT/aOqTpYIuivYXtQPb/PZc4xQZvoaodttktrgG4U4U9N/m362J8AxcrmzzyDprYKdv4K15GYc4xPilJ1Jaa36GRTg4ShIcE7OOUndieSbq/y4VWeNMeV3vrukNsvQIpmmojXQZ19bOiQaUtOvwZJzixxp3L/hmAQnJvTwiyXyVgh1tAzihC2VC2jwEuJYPn97TCMLDZA9Bal1fBruRv4MGLD29AzLIpD03YCW+QoM4060jCTFLRqoD1fZS5WkPNbV1DIGkmxWcGzLPzErVDV3O1un7dJqm/bv5YTlkPqz9sENSC8ow2L/zBt4aHc8TsbAo55e72QiHhMHRsXw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=intel.onmicrosoft.com; s=selector2-intel-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=JJpE/WraCRSYYFgqqLqF1RKUvNVooWzLu2JNZwkK9mE=; b=qZxikNoebsYHmIUf1ea4QsUkACMb4tu8M139q+5igiUJXkAReCedSR0wDiFxCrLL2p38nK4tIq6qaXKVf1BbFRPjM/ClK6WlhdAhvGbxUAhZwCUbF7tB6gYvCofnI181zedxDAXfBQAH5H6c8lqcjD8pU1uDZUw7aZ3whZkvA44= Received: from DM6PR11MB2555.namprd11.prod.outlook.com (2603:10b6:5:c5::33) by DM6PR11MB2697.namprd11.prod.outlook.com (2603:10b6:5:c3::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3412.29; Thu, 1 Oct 2020 08:31:51 +0000 Received: from DM6PR11MB2555.namprd11.prod.outlook.com ([fe80::78d4:d670:95af:773d]) by DM6PR11MB2555.namprd11.prod.outlook.com ([fe80::78d4:d670:95af:773d%5]) with mapi id 15.20.3412.028; Thu, 1 Oct 2020 08:31:51 +0000 From: "Power, Ciara" To: Thomas Monjalon CC: "dev@dpdk.org" , "Mcnamara, John" , "Kovacevic, Marko" Thread-Topic: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from Linux guide Thread-Index: AQHWkCAnT4YcDWtF7kalurY9XLDonqmBzGGAgACt98A= Date: Thu, 1 Oct 2020 08:31:51 +0000 Message-ID: References: <20200807123009.21266-1-ciara.power@intel.com> <20200921135931.13355-1-ciara.power@intel.com> <20200921135931.13355-4-ciara.power@intel.com> <3051248.mg5JyDbmDi@thomas> In-Reply-To: <3051248.mg5JyDbmDi@thomas> Accept-Language: en-IE, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-version: 11.5.1.3 dlp-product: dlpe-windows dlp-reaction: no-action authentication-results: monjalon.net; dkim=none (message not signed) header.d=none;monjalon.net; dmarc=none action=none header.from=intel.com; x-originating-ip: [37.228.239.233] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 4d2bc5ac-d98e-4f8a-e92d-08d865e4722b x-ms-traffictypediagnostic: DM6PR11MB2697: x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:10000; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: nRaRVxEw/AQn2Dr/aFICQSNP0Jz2KoJLIIGKJNYNbyf40FxgauVlQOnWJrV6xw+E+67AV0+XnIvWDJBKpuSI5sdzetzSEzIVMF6MMz070uvFzkJbG/q/euw6vif310Au5/YNWfUMu0O6GE3g6XU7OgpkmGsXSvq9eT4fuO9fv1lz3Cva1mINc2btmEIQH5Vz945c+Zs3AAL5ES922mJa5nBjZPNWDs8ElAweqGefNx5exyUtv5gdku1pddwj6XXxeD1f+5YMPP86I5PfbFJN+4zrZQ1OQuCY9giTP1Ek0tfTqqAfmfVvrsBpYL0z49uCs6DPnS9RqFRFJSME+05xHn+glY0Kp+SyXjPRqXWzO21Jzhex8RrJMpshcpKY0poI x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DM6PR11MB2555.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(366004)(346002)(39860400002)(396003)(376002)(136003)(76116006)(66476007)(33656002)(4326008)(316002)(83380400001)(26005)(66446008)(66946007)(66556008)(6916009)(107886003)(9686003)(86362001)(5660300002)(54906003)(6506007)(186003)(64756008)(71200400001)(7696005)(55016002)(2906002)(8676002)(8936002)(52536014)(478600001); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata: SKGYhFV24JDtZQzj34TAZ9HpB6jhIBTmLGeFqRNfiyRC1CVczDpsGYhuh/oQUXRqQdRd7L3OmhtTWXd50JaxuInbI9fdY5BJVlkhjz/9wCF5KZb7+1fhGH5UZF6dJEhUDOdB4V6mhMOKA2SUyj9EShNzIgf36e9Q3QUW3QlOLXatsjz/DYtiefD2RuImx7w5a90HdbdXfeNH/radDgkB+D681d1nxaTwGv6SwYF4KB9FvMEyK4H/YvHLtrDquYsRgiBexlKSXX6Kd7tDzQonVszMM3EcP3Kii+218ZSomkdjgsdJEzUFQnXNuWlG3+Gdwd2zSRixNXIuAdwVLdtr3Xb0W/t+BUYUe6AEy7C6hfDFxsNtzDFE3nqSEIAdaNmfFQlBfwCRV+fam/wipuiJTxxdpIx5QslRXgV7xWoNbUdyWNPBfOKlANIonhLpnrTIfOMfhiFvJKloVs834LzLlrF0lVxQMFNYCyhRlt0G2+hFGd72QjZKU+r+x+KiaB/UQm2ImSz8tRXDoIKE71GG/Yiz6er3QfP5baRvQ27VUrkImq96YOpVoyrj+wqaZxQSXD1+O3wKItQBeKgLMCdkDvHxKJTIhATjrdCZm03d0agPHE4+C2Tcf5JBR5JNlyywZOWFhkSJP7C1THmIqgYByA== Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: DM6PR11MB2555.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 4d2bc5ac-d98e-4f8a-e92d-08d865e4722b X-MS-Exchange-CrossTenant-originalarrivaltime: 01 Oct 2020 08:31:51.3455 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: YQBgjYki4I26QDhCce1v+pb1BEfBqXPXN/xFcwO4On6KW24WiV8GdVjdPNjKDc0sB+Xab2smL+YmiNysAA0Vdw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR11MB2697 X-OriginatorOrg: intel.com 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" - Ciara -=20 >-----Original Message----- >From: Thomas Monjalon >Sent: Wednesday 30 September 2020 23:09 >To: Power, Ciara >Cc: dev@dpdk.org; Mcnamara, John ; Kovacevic, >Marko >Subject: Re: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make >from Linux guide > >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. >> >> 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(-) >> >> diff --git a/doc/guides/linux_gsg/build_dpdk.rst >> b/doc/guides/linux_gsg/build_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 add= ed >> to a file in `/etc/ld.so.conf.d/` before running `ldconfig`. >> >> +.. _adjusting_build_options: >> + > >extra blank line > >> >> 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 configuration file. >> >> +.. _building_app_using_installed_dpdk: >> + >> + > >extra blank line > >> Building Applications Using Installed DPDK >> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ >> >> @@ -135,11 +140,12 @@ and the sources for that build are stored in >``$(SRCS-y)``. >> >> .. note:: >> >> - 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 s= et >> - using the `--prefix` meson option (default: `/usr/local`). >> + Unlike with the make build system present used in older DPDK release= s, >> + 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 a= nd >keep the rest of the line wrapping untouched. > >> >> 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/linux_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. >> >> -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 > >> >> The chapter describes how to compile and run applications in an DPDK >environment. >> @@ -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 an= d >are to be used for running the application):: >> >> - ./helloworld -l 0-3 -n 4 >> + ./dpdk-helloworld -l 0-3 -n 4 >> >> .. note:: >> >> @@ -183,19 +183,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 examples >directory. >> These sample applications may be built and run in a manner similar to t= hat >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 an= d >execution and some explanation of the code. >> - >> -Additional Test Applications >> ----------------------------- >> - >> -In addition, there are two other applications that are built when the >libraries 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 dire= ctory. >> - >> -* The test application provides a variety of specific tests for the v= arious >functions in the DPDK. >> - >> -* The testpmd application provides a number of different packet >throughput tests and >> - examples of features such as how to use the Flow Director found in = the >Intel(r) 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 >> ---------------------------------- >> >> 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 >directory. >> -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 s= ee >: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 load and bind to the network ports. >> >> +.. _load_uio: >> + >> + > >This anchor is not need in my opinion. > >> UIO >> --- >> >> @@ -28,19 +31,20 @@ can provide the uio capability. This module can be >loaded using the command: >> ``uio_pci_generic`` module doesn't support the creation of virtual >functions. >> >> 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 above. It can >> be loaded as shown below: >> >> .. code-block:: console >> >> sudo modprobe uio >> - sudo insmod kmod/igb_uio.ko >> + sudo insmod /kernel/linux/igb_uio/igb_uio.ko >> >> .. note:: >> >> - ``igb_uio`` module is disabled by default starting from ``DPDK v20.0= 2``. >> - 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 reposito= ry. >> + Building DPDK Linux kernel modules is disabled by default starting f= rom >DPDK v20.02. >> + To enable them again, the config option "enable_kmods" needs to be s= et >in the meson >> + build configuration. See :ref:`adjusting_build_options` for details = on how >to set/clear >> + build options. It is planned to move ``igb_uio`` module to a differe= nt git >repository. > >In general it is better to split the lines logically to ease future patche= s diff. > > > >