From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 47D96427ED; Wed, 22 Mar 2023 03:54:15 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2508B40E09; Wed, 22 Mar 2023 03:54:15 +0100 (CET) Received: from mga03.intel.com (mga03.intel.com [134.134.136.65]) by mails.dpdk.org (Postfix) with ESMTP id 594F940A84 for ; Wed, 22 Mar 2023 03:54:13 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1679453653; x=1710989653; h=from:to:cc:subject:date:message-id:references: in-reply-to:content-transfer-encoding:mime-version; bh=povnozfMGO20CH6utu4k+T5hzcoYFfNKCfE59t5BTVg=; b=D0UWIwahjvJkq99odKcFP8Et84HsoE8GIXjuNYpnozZ7bxya3j55NsWy QQZsCd5mZLsxJ8G5Ay14lmAWJIYt9LlUfCqC5gbdGSx+mVZ8NHyNT+euK OzHid7HBmYvotsDHO8b1eahk63uKYzbIlNaCo6BxPw+VVqqnIItIWH1/T tlcenUF70Rknsdy8lIC8Ihevi4gv/LYlwGS62zvYHZqbcS5VyULo+Q3Zj 8N7Oz9NZreHC7jGbinDRc+gbSotJKB4utQkb4bo60TRKtZjoNWX1QBEfv K3Efe++W5YW/d6dnZA6EhdPJjbHpNERc2Al6gqwlRe/bn2HI83+87kiiT g==; X-IronPort-AV: E=McAfee;i="6600,9927,10656"; a="341470090" X-IronPort-AV: E=Sophos;i="5.98,280,1673942400"; d="scan'208";a="341470090" Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 21 Mar 2023 19:54:04 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10656"; a="770889963" X-IronPort-AV: E=Sophos;i="5.98,280,1673942400"; d="scan'208";a="770889963" Received: from fmsmsx601.amr.corp.intel.com ([10.18.126.81]) by FMSMGA003.fm.intel.com with ESMTP; 21 Mar 2023 19:54:04 -0700 Received: from fmsmsx610.amr.corp.intel.com (10.18.126.90) 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.2507.21; Tue, 21 Mar 2023 19:54:04 -0700 Received: from fmsmsx603.amr.corp.intel.com (10.18.126.83) by fmsmsx610.amr.corp.intel.com (10.18.126.90) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.21; Tue, 21 Mar 2023 19:54:03 -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.2507.21 via Frontend Transport; Tue, 21 Mar 2023 19:54:03 -0700 Received: from NAM10-MW2-obe.outbound.protection.outlook.com (104.47.55.105) 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.2507.21; Tue, 21 Mar 2023 19:54:01 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=nKScWjofpIjyQBfSnz10Yl7/ounSCmynCd7Fx/eGkAwDDTrtsE3XEilDdOaWf47cK+KjLLHOLJiBVutSsJwKM8IL2PksBV7+PlOAs6sSmUAJ1V5C1AuyWSHNcgmZnMeuBsYvmI7pBrlI79VpXU3eQVFLZ2V0TIv0fGi5fNM8sPorhj6CxbPvSTl6DGXGdh1tNSnAV/JBaqa9xiPRAUbBBeJfekkI348WoPEhfW989l16V3jc73CG66BCc8X8lLJ3i7fD90paRD751OtbfaZ7n9/AFP+Z3ccSrDCxDH6DELB08cQPRUJ8jA4C4GS1u71MwOBYkWq3Yo++fWtKbOFqAA== 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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=Jh4p+1x/3oetb1IvYBZVP0bOvblV8x/C0+HX4+7Wleo=; b=QzvtPCxVCA8Ch5f+fGLnwEycLIfup0gf5Nv8LQU94ap5JFFwcIs8kbuRfxovh6OFmvdFUrbHww1A71rpa4JR3QsDfRtgS19Kp3WZAfrtFcsMReOnp52tGDIgK80B1YngRQVx2p7FpBzwsC1xxJ+sI0fy+mQjm/QVsm9yN6+54FxLr999vjwVgUd/R9Mlq5sCQ0sEwQYvw6XxVk584aM0A8fbNNRfE7YrudSNDZdEU05fS/cc3yVyPdIN5V2k5StM7WOcrEBpPHEYhb6iMmbZ+sG0PL/x15krJ4dSmjjr9niyDoxlD4ZLtIDaAMyCpk5uJAyiJ7Ij6WME+ZbC5Hlrog== 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 Received: from DM4PR11MB5994.namprd11.prod.outlook.com (2603:10b6:8:5d::20) by DM8PR11MB5608.namprd11.prod.outlook.com (2603:10b6:8:35::5) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6178.37; Wed, 22 Mar 2023 02:54:00 +0000 Received: from DM4PR11MB5994.namprd11.prod.outlook.com ([fe80::2c5d:49cd:a9b4:f764]) by DM4PR11MB5994.namprd11.prod.outlook.com ([fe80::2c5d:49cd:a9b4:f764%7]) with mapi id 15.20.6178.037; Wed, 22 Mar 2023 02:53:59 +0000 From: "Zhang, Qi Z" To: Ferruh Yigit , "Mcnamara, John" CC: Thomas Monjalon , Andrew Rybchenko , "dev@dpdk.org" Subject: RE: [PATCH 00/33] Update net driver documentation Thread-Topic: [PATCH 00/33] Update net driver documentation Thread-Index: AQHZXFFjXfGl8lcJDkOA8z850ZPuFa8GGD+g Date: Wed, 22 Mar 2023 02:53:59 +0000 Message-ID: References: <20230321235941.2169068-1-ferruh.yigit@amd.com> In-Reply-To: <20230321235941.2169068-1-ferruh.yigit@amd.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: authentication-results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; x-ms-publictraffictype: Email x-ms-traffictypediagnostic: DM4PR11MB5994:EE_|DM8PR11MB5608:EE_ x-ms-office365-filtering-correlation-id: 2f2b012a-49fb-434b-81b2-08db2a80af91 x-ms-exchange-senderadcheck: 1 x-ms-exchange-antispam-relay: 0 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: ZwQOGcGfOGuKN4fO8BGzlW3DoGv4gvOLKGTHItU21ZohzmU9fE6drNvL9AfUVkxTBx9O4OmnRK7WU5mhFIpTd6jFfAP8lFiUpC5OfEjHmFbtIrOMNsKKT4BfNofJh4syT3VGVOH9PMrGkNg83gPdYGCSCmd+JA0IdIE1sh8mYho2Yy+x805ePuh4Olw8rNlCO5zWJYB/Flkl6RWvnexxgcrxj5pGxRX9cOPat6xLAH9VuZj5FSS2vHIRKprf31Yb4nSl4Nsrt+7+l37aS9ohZd07ct9yZkxig1pjJJUEnCWUV+qKSmVn+aNXVRMRY9xWhj0go1m2Iy0CE7Hn3S6D+tRBQwB/wJYd2+9/Mw7HvHs2EbjaqQHsy2DXhqStRJLJYvXG8ufNQNC9E1qKnUbNwIpWOJEgQnHaHTxKxl8oPYDOlZRUmQst7rXg5M0ALsk5ugxVZFxZYGSq+B0vLafblU9eRcJ+79NjAt45aHb9Uh9IQl2aYTJhUmxbIu08PuKTYymUc94DbWRN4qTDYxSNDxkyRjEKgSKIK/2R/BrXJc7VhAdlOALl0FRAjaOWDSZoOkmZTPPWZr70t9Jpw4BijarIaY+p1iaoCRL/N97wijgEKQjHJoHxVSMx/lO3EhgY0JUZQNRNwpTKImczntgG2q+a6/+fFyykMs9l2/4nxFmB8C/ArmPnBHkDgi+A8grywlDykfAMTR0aZ2iX+1L5ww== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DM4PR11MB5994.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230025)(376002)(366004)(39860400002)(396003)(136003)(346002)(451199018)(8936002)(5660300002)(52536014)(55016003)(33656002)(86362001)(38070700005)(38100700002)(2906002)(122000001)(15650500001)(82960400001)(4326008)(83380400001)(478600001)(7696005)(41300700001)(186003)(71200400001)(26005)(9686003)(6506007)(54906003)(53546011)(6636002)(110136005)(316002)(8676002)(64756008)(66556008)(76116006)(66446008)(66946007)(66476007); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata-chunkcount: 1 x-ms-exchange-antispam-messagedata-0: =?us-ascii?Q?ptm6XTUblIl8s9y7vTxp1b8NnN01kPldVIl7ZbyDO9Mk1fm32Iw63dcE6zlJ?= =?us-ascii?Q?ie5GsYfmxOy+3Z9H/c96Zg1r7+z8jrq9cVWjdv6kStuloVLMQXzCJtw8Nj4x?= =?us-ascii?Q?D48XRulLT+t1zeF6JcXRajXfC3mozhPiFu8CxkTuSx/cm1DPerI8CIQlv2NO?= =?us-ascii?Q?bCSeaav3v5ciuun4NDnYbD18visxFOQrJSnusOP0QuC9IdsZvPAo4Qcw8f7R?= =?us-ascii?Q?N44H4Pzkqn56BfueIq5rjgwLn3q7MwLRT+pMudf7isifpRXFN5hrR4R0FV66?= =?us-ascii?Q?1WuJfHc2JmLNaASIU27BJWpOnbCwCWbk4p6UjhWqUafoyVtsZXzwJ+yvthxM?= =?us-ascii?Q?ZU7mtzB1WTWL7O5MPttFjjMqRIxYKJkaia6y3kVZwOdcV7KehKvZymP+oMsE?= =?us-ascii?Q?+nAqn3ikOxM40FGNszni9pyEpamPRhwvdpvpFvNQ6YS51iiF5gPS6Hl3pTid?= =?us-ascii?Q?sHD0p/qjj6H0qc17BTr4kw+WMqAzzTmYERA6aUt0/utU1hFAElY1Ge5zk6nq?= =?us-ascii?Q?A9mFkVWpm07O8nNPOglbhs1g3/gy51UC1hZ0ZwYVB4NymwLz2XwP0Kf85SMa?= =?us-ascii?Q?DYFmigJbJLfg4pTwfe7zSOqNxa33xsVJnsc+vA9IIttQuDZMFXLlEy+zr0r+?= =?us-ascii?Q?YP72k2VNGzwwY3gXKf4GlfsTjQcClRE8ZbzCt8oK41PHW2N6ZXkpceZDSkmi?= =?us-ascii?Q?yXLJsSy/jLDkknOCRDvqtqHIGVHbDVH8DzgN1XCthygViZ9ABJMyTEqt2paF?= =?us-ascii?Q?/Awb7eGvNXr/mSRJUHFgqtsSUjuxDtzP1YlC/tcq7mGUdPCVmmfCZpuxJjlM?= =?us-ascii?Q?2RANPd3zfORJQmWNOa3tPwsqq5jip4FBIrgSOvTwCCFiZ0+aBoOdW42dDO4g?= =?us-ascii?Q?X1qmSrVujDQ4M3eZw8n9TFqIt1D3EJFfllRUyHpG0UZOw98yjTTx8ualBltz?= =?us-ascii?Q?jQGTtUYgwf1c9HqOlrujedv7b+TFTI1nEQMyze2MAY78x4+4ZUKZiHVYAy+H?= =?us-ascii?Q?vKILNVYMoR8rpswyTqpPo543cLAfvYnhOfRs3iXS2dHCN6549Ab77cSnB8EK?= =?us-ascii?Q?CgTUquBT3ZZhVi3X7zmMMoNPur+DXCvnpshereYlg0S8y1zXYt/TVeoKI0gT?= =?us-ascii?Q?Fs9GNQiQ7kWcCQUgdXdPKNKz+V82pFX7OmnsH2abkRsEH4tgpjZXnayxiFR7?= =?us-ascii?Q?uxokB5FqI1pOyp/eMLo2/zvNXcFUY7ilZSRfbu+4siB5nFkwJKUdECxBtPOe?= =?us-ascii?Q?kW+eTO7CzQFiioUvF1CafpsRq3PqtxW4sH0rc1yg35F0KKAMnVA9CkTv8mFx?= =?us-ascii?Q?5MYeQwmcmG2P4teos4MXGTyJpIB6qVPvXtkjbRxDe6M0R7x8Sn9cqtbyrFrE?= =?us-ascii?Q?9g/5RFs4cGCClwTa8WEYvw6F9wPFD4tRWm47t7cYVmG80ejaBkjkjRk5aywr?= =?us-ascii?Q?RLYTpsSZnsMM/PTTAqY5CHslJWDvORa8Gcki1MpiQAO462EzRd4LeB7kn3O1?= =?us-ascii?Q?XKCsvZoMGoEAOf4ZKgVq7r2KhUhe/cadtylzEvxUq5LzZWwj50wI3P8F741P?= =?us-ascii?Q?z1gDVDFGETZ3Wzl16XpiBhMPtdBCxzE5O7qM2hyH?= 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: DM4PR11MB5994.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 2f2b012a-49fb-434b-81b2-08db2a80af91 X-MS-Exchange-CrossTenant-originalarrivaltime: 22 Mar 2023 02:53:59.2630 (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: /yCVg+T6M804xXle7k8kH3xRLyAwxIFBIYoiXUXTWPIBmRtWiWSaalzXcQYL2kiPrDRrh6TlPl4CZmYhRxlnWw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM8PR11MB5608 X-OriginatorOrg: intel.com X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org > -----Original Message----- > From: Ferruh Yigit > Sent: Wednesday, March 22, 2023 7:59 AM > To: Mcnamara, John > Cc: Thomas Monjalon ; Andrew Rybchenko > ; dev@dpdk.org > Subject: [PATCH 00/33] Update net driver documentation >=20 > Some PMDs has "Pre-Installation Configuration" section in their > documentation, although section is not clear I assume that is historical = from > times compile time parameters and 'make' build system used, where > common make target was 'install', so section refers to compile time > configuration. >=20 > Right now device arguments ("Runtime configuration") is documented under > this section which is confusing, so updating section name from "Pre- > Installation Configuration" to "Configuration". >=20 > While touching documents trying to keep following template in the > documents, with section names and order, to have consistent documents > without being too strict on applying the template: >=20 > [Overview] > Supported Devices > Supported Features > Prerequisites > Configuration > Compilation Options > Environment variables > Runtime Configuration > Debugging > Limitations or Known issues > Testpmd driver specific commands >=20 > Note: Patch sent as each driver separately to help review, it can be squa= shed > while merging. >=20 > Other further improvements not covered here can be visiting "Building > DPDK" sections which has redundant and less useful information, and > "Usage example" section which has testpmd log, most of the part is same f= or > all drivers. >=20 > . >=20 > Ferruh Yigit (33): > doc: update atlantic guide > doc: update cpfl guide > doc: update cxgbe guide > doc: update dpaa guide > doc: update ena guide > doc: update enetc guide > doc: update enetfec guide > doc: update enic guide > doc: update hns3 guide > doc: update i40e guide > doc: update ice guide > doc: update idpf guide > doc: update igb guide > doc: update igc guide > doc: update ipn3ke guide > doc: update ixgbe guide > doc: update kni guide > doc: update mana guide > doc: update mlx5 guide > doc: update mvneta guide > doc: update netvsc guide > doc: update ngbe guide > doc: update net null guide > doc: update octeontx guide > doc: update pfe guide > doc: update qede guide > doc: update sfc guide > doc: update softnic guide > doc: update thunderx guide > doc: update txgbe guide > doc: update vdev netvsc guide > doc: update vhost guide > doc: update virtio guide >=20 > doc/guides/nics/atlantic.rst | 27 +++----- > doc/guides/nics/cpfl.rst | 51 +++++++------- > doc/guides/nics/cxgbe.rst | 61 ++++++++--------- > doc/guides/nics/dpaa.rst | 5 +- > doc/guides/nics/ena.rst | 60 +++++++++-------- > doc/guides/nics/enetc.rst | 25 +++---- > doc/guides/nics/enetfec.rst | 12 ++-- > doc/guides/nics/enic.rst | 79 ++++++++++------------ > doc/guides/nics/hns3.rst | 30 ++++----- > doc/guides/nics/i40e.rst | 10 +-- > doc/guides/nics/ice.rst | 8 +-- > doc/guides/nics/idpf.rst | 8 +-- > doc/guides/nics/igb.rst | 23 +++---- > doc/guides/nics/igc.rst | 16 ++--- > doc/guides/nics/ipn3ke.rst | 9 ++- > doc/guides/nics/ixgbe.rst | 62 ++++++++--------- > doc/guides/nics/kni.rst | 4 +- > doc/guides/nics/mana.rst | 4 +- > doc/guides/nics/mlx5.rst | 116 ++++++++++++++++---------------- > doc/guides/nics/mvneta.rst | 4 +- > doc/guides/nics/netvsc.rst | 4 +- > doc/guides/nics/ngbe.rst | 4 +- > doc/guides/nics/null.rst | 4 +- > doc/guides/nics/octeontx.rst | 15 ++--- > doc/guides/nics/pfe.rst | 25 +++---- > doc/guides/nics/qede.rst | 14 ++-- > doc/guides/nics/sfc_efx.rst | 94 +++++++++++++------------- > doc/guides/nics/softnic.rst | 4 +- > doc/guides/nics/thunderx.rst | 16 ++--- > doc/guides/nics/txgbe.rst | 12 ++-- > doc/guides/nics/vdev_netvsc.rst | 4 +- > doc/guides/nics/vhost.rst | 4 +- > doc/guides/nics/virtio.rst | 4 +- > 33 files changed, 395 insertions(+), 423 deletions(-) >=20 > -- > 2.34.1 For Intel nic i40e/ice/ixgbe/idpf/cpfl/igb/igc/ipn3ke Acked-by: Qi Zhang Thanks!