From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from dpdk.org (dpdk.org [92.243.14.124])
by inbox.dpdk.org (Postfix) with ESMTP id 2E61BA04B5;
Thu, 1 Oct 2020 10:36:21 +0200 (CEST)
Received: from [92.243.14.124] (localhost [127.0.0.1])
by dpdk.org (Postfix) with ESMTP id A0CD51D9EF;
Thu, 1 Oct 2020 10:36:19 +0200 (CEST)
Received: from mga04.intel.com (mga04.intel.com [192.55.52.120])
by dpdk.org (Postfix) with ESMTP id 78C961BCA2
for <dev@dpdk.org>; Thu, 1 Oct 2020 10:36:17 +0200 (CEST)
IronPort-SDR: hL+qMRs4YoCse6gyIQaUzev8JE/5ZnPGgA1cVrKfD8TgtPcRqTRxkQ8WkgqjGPd3mfOCiPtSzX
pOJUI1TVoXJQ==
X-IronPort-AV: E=McAfee;i="6000,8403,9760"; a="160068110"
X-IronPort-AV: E=Sophos;i="5.77,323,1596524400"; d="scan'208";a="160068110"
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga004.jf.intel.com ([10.7.209.38])
by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
01 Oct 2020 01:36:15 -0700
IronPort-SDR: K4jxNeJrrnDLjEfIoraVjidrPNrqzsxE6J8EZhErk+sL1gld1Vez+0nTTCGlv9U/8K4FhO8IEE
bPuJM1DJ6JvA==
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.77,323,1596524400"; d="scan'208";a="458039935"
Received: from orsmsx601.amr.corp.intel.com ([10.22.229.14])
by orsmga004.jf.intel.com with ESMTP; 01 Oct 2020 01:36:15 -0700
Received: from orsmsx607.amr.corp.intel.com (10.22.229.20) by
ORSMSX601.amr.corp.intel.com (10.22.229.14) 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:36:14 -0700
Received: from orsmsx612.amr.corp.intel.com (10.22.229.25) by
ORSMSX607.amr.corp.intel.com (10.22.229.20) 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:36:14 -0700
Received: from ORSEDG602.ED.cps.intel.com (10.7.248.7) by
orsmsx612.amr.corp.intel.com (10.22.229.25) 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:36:14 -0700
Received: from NAM11-DM6-obe.outbound.protection.outlook.com (104.47.57.174)
by edgegateway.intel.com (134.134.137.103) 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:36:14 -0700
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;
b=J2cXgD907nqrlzII9HogXTVJSYg6P0YDONwZZIPogpujf9Zr7+et8SLrMkNeS/oYg58yKQ/COdufHsfVucnsD04SscvQuCRfmAX7jelZQbjhA8pR7hbk3dgBkrs1YrXYCXCb8DxszLQm+q7xt1v0154VZK2j3JAEoIvLhyx/n01Yed9jEyDVZmKlq6wzb1nuqyfVkkZz/+vm5syVco5wCMIOqHSGVFl5Lu+RBkZK0nTrgUA+rZfAaLgEsQJ0zMoCJ2o0YZKik1jVT42R/t+RGPXTJHSBbPWWt3dsvU40ugYCSFvUXdMVbJyqZ9SslkjvVZ/oxNUgbFjVa+MNPQhuig==
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=+0dJ3W6uy+bpT8BmScvUTpdgZP4Ekg5FWfOuelz9Nyo=;
b=D9DmajxR04jVJdUJ7fuV4XlcjC+yyz1qyXx3kL86M9VwVxu4HtrqCgOICIfGPYQUnol6oT0bjGgu55L0igPE/VgQLrtV67qqy1MLu9qCMaJjrHRjl3/OlkJ4+SdAjtVWI4YtnxUmsqjxFNFSb5A9haL5Y/xa+DJ9BzSTSGmoTCvTJLpyAlHkuLIQWBasxmcFM0M5QNUoIAUkV1OJ7amBvbsHTIX6WvL2KrCDHfLXq9NrCDKapMVPN6BUF+C+nDgyawF/O1f9SnddsEyP32Fqm5OpXjoIj1gEUwDG2naCIXmn5xLc9fpx4e+dA3jBBKqtR1Huw0S+mWFf+by7YlIHdA==
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=+0dJ3W6uy+bpT8BmScvUTpdgZP4Ekg5FWfOuelz9Nyo=;
b=zBwtXoSwnGJZf8EP5U1ZzItzfoK81iUSPGn7lUgcAbKtax8t2CZOGlUvQXz8OjGBdsuCp/xvErFLw9t5CeqEW2eQo+9IYdGI4Xf8afcQgGJdjN+KBU2JzwHHJwdkQhTCvmbSCSfYdMxuIXX0vMLhy0M7vDa44wsnhFagZCRLoFk=
Received: from DM6PR11MB2555.namprd11.prod.outlook.com (2603:10b6:5:c5::33) by
DM5PR1101MB2138.namprd11.prod.outlook.com (2603:10b6:4:57::18) with
Microsoft
SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
15.20.3433.35; Thu, 1 Oct 2020 08:36:13 +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:36:13 +0000
From: "Power, Ciara" <ciara.power@intel.com>
To: Thomas Monjalon <thomas@monjalon.net>
CC: "dev@dpdk.org" <dev@dpdk.org>, "Mcnamara, John" <john.mcnamara@intel.com>,
"Kovacevic, Marko" <marko.kovacevic@intel.com>
Thread-Topic: [dpdk-dev] [PATCH v5 03/20] doc: remove references to make from
Linux guide
Thread-Index: AQHWkCAnT4YcDWtF7kalurY9XLDonqmBzGGAgACuGrA=
Date: Thu, 1 Oct 2020 08:36:12 +0000
Message-ID: <DM6PR11MB255570B208E1338050653A4BE6300@DM6PR11MB2555.namprd11.prod.outlook.com>
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: 54ad9df1-0d0f-4685-dfca-08d865e50e1a
x-ms-traffictypediagnostic: DM5PR1101MB2138:
x-ms-exchange-transport-forked: True
x-microsoft-antispam-prvs: <DM5PR1101MB2138C877444674CC9B5B08E5E6300@DM5PR1101MB2138.namprd11.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:10000;
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: KaQyNY2SOXEuTYNOOGUf+RbXPM3hVWGc0utEKYFtC2ju4bAhnewO+S0WvGJJnKOqE2DSPKsTuzaf6lfo33re+UwL0YaXWKHyOk5FlpNjy8EhI/ertE4rI5ak74fVXpjz2rafkPO9uQZPcihXUJufZjW3HNgAoGLJ72vwLmmG+lbKvyhrQ7S7kouNeFKTxOqKWAETwKpowj9lzOpMjCclML01q8dCTPt0X6IJUEuCLFnxY824aNYqOyjmFNJ5pLoGl0jrkE2kTFmssxNJNrP+IEFP0q9cYesGzKEqaCq6jGYntYSu+EYUjlzhd85/LtonN0jFU9ULF/BKA1eL3w9Rlg==
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)(39860400002)(136003)(366004)(396003)(346002)(376002)(66556008)(6916009)(66946007)(7696005)(6506007)(76116006)(4326008)(71200400001)(66476007)(66446008)(33656002)(478600001)(316002)(64756008)(86362001)(52536014)(54906003)(8936002)(8676002)(5660300002)(26005)(186003)(83380400001)(9686003)(55016002)(2906002)(107886003);
DIR:OUT; SFP:1102;
x-ms-exchange-antispam-messagedata: pVtQfsNAVWRi7HGnMvCKajrHbGDKs/g/GhAfRyXFyG611Gy6R40prM6+QDJgXg1mIFbXzs+vIqGBCU/Adb7LmggnhBbqlHyA1RLJEmEPZvxJHtkME57lBLd1QY/d1NC+x/HtGwvVH8Es8fsnT3khVkLOop8l/4GXhjmg0ecMw2tCnTgldUyqnVlkKDYDH3PXhWJc1dsfSSEHH7+IYbKzVBxuiGEBWkN8kjX0f4rqpxieCBe3IO2hPORqU4grZMzUn+x4DBkMeEdu4yfiVcRlMSelh8x3RK8wXQCMvNHxTwQa1kXy1htw8mAz8q3jbFbnywTNRv77IfqEmcT0blNqeHPu+uRttUGB3BeVZcticSEphfqEto94MXbl/UhsY3oew5E3GS2XUwRRlAxZdCQ8sogMPsU9lZj8g0WYe2gt91A1hiO3/wMzAnjkkbyzn1biYeTXDbb3xf1DtAYUyJ8aWowodgaCOVaDI1r881hUObkjoHE0kHGCIDk+ZqlycUVT7srVkAG6dWPEftYL+X2OFs27mNeJX16kTQ+AekJlkoTAOxPF3evSgNqxJgdK5/OsDjTbl/1nOB9yDKZxQb4dH6x5nbhNYGw62HUOhIlpodn7DcqHIJgjyTWKm8CGEm/VbcMSMkJlBwP3JJOHvpupKQ==
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: 54ad9df1-0d0f-4685-dfca-08d865e50e1a
X-MS-Exchange-CrossTenant-originalarrivaltime: 01 Oct 2020 08:36:13.0014 (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: A78aDuAuJfd7S0GcrqSlM8A/DXM1OEEKk26/HaTJH017IaMUS0raZwbzq5Ls4E5rP+LS5DA393BbPwZ9KeTSVA==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR1101MB2138
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 <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
Hi Thomas,
Apologies for the previous email, accidentally sent before I could fill it =
in!
Most of these suggestions seem fine to me, left some comments inline.
Thanks,
Ciara
=20
>-----Original Message-----
>From: Thomas Monjalon <thomas@monjalon.net>
>Sent: Wednesday 30 September 2020 23:09
>To: Power, Ciara <ciara.power@intel.com>
>Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>; Kovacevic,
>Marko <marko.kovacevic@intel.com>
>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 <ciara.power@intel.com>
>> Reviewed-by: Bruce Richardson <bruce.richardson@intel.com>
>> ---
>> 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
Blank line here, and below, were added based on the contributing guide - " =
Add 2 blank lines before each section header."
Okay to remove if that has changed.
>
>>
>> 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.
>
I think this was a typo on the first line, should have been either "present=
" or "used", not both.
>>
>> 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
I think this should be the updated path:
" <build_dir>/kernel/linux/kni/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 <build_dir>/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.
>
>
>
>