Cover Detail
Show a cover letter.
GET /api/covers/125375/?format=api
{ "id": 125375, "url": "http://patches.dpdk.org/api/covers/125375/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/cover/20230321235941.2169068-1-ferruh.yigit@amd.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20230321235941.2169068-1-ferruh.yigit@amd.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20230321235941.2169068-1-ferruh.yigit@amd.com", "date": "2023-03-21T23:59:08", "name": "[00/33] Update net driver documentation", "submitter": { "id": 2700, "url": "http://patches.dpdk.org/api/people/2700/?format=api", "name": "Ferruh Yigit", "email": "ferruh.yigit@amd.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/cover/20230321235941.2169068-1-ferruh.yigit@amd.com/mbox/", "series": [ { "id": 27488, "url": "http://patches.dpdk.org/api/series/27488/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=27488", "date": "2023-03-21T23:59:09", "name": "Update net driver documentation", "version": 1, "mbox": "http://patches.dpdk.org/series/27488/mbox/" } ], "comments": "http://patches.dpdk.org/api/covers/125375/comments/", "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id F39CD427F9;\n\tWed, 22 Mar 2023 01:00:05 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 1B82A427F2;\n\tWed, 22 Mar 2023 01:00:02 +0100 (CET)", "from NAM10-DM6-obe.outbound.protection.outlook.com\n (mail-dm6nam10on2051.outbound.protection.outlook.com [40.107.93.51])\n by mails.dpdk.org (Postfix) with ESMTP id 69C6740A84\n for <dev@dpdk.org>; Wed, 22 Mar 2023 00:59:58 +0100 (CET)", "from MN2PR14CA0005.namprd14.prod.outlook.com (2603:10b6:208:23e::10)\n by IA1PR12MB7496.namprd12.prod.outlook.com (2603:10b6:208:418::10)\n with Microsoft SMTP Server (version=TLS1_2,\n cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6178.37; Tue, 21 Mar\n 2023 23:59:52 +0000", "from BL02EPF000100D2.namprd05.prod.outlook.com\n (2603:10b6:208:23e:cafe::a3) by MN2PR14CA0005.outlook.office365.com\n (2603:10b6:208:23e::10) with Microsoft SMTP Server (version=TLS1_2,\n cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6178.37 via Frontend\n Transport; Tue, 21 Mar 2023 23:59:52 +0000", "from SATLEXMB04.amd.com (165.204.84.17) by\n BL02EPF000100D2.mail.protection.outlook.com (10.167.241.206) with Microsoft\n SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id\n 15.20.6178.30 via Frontend Transport; Tue, 21 Mar 2023 23:59:52 +0000", "from telcodpdk.amd.com (10.180.168.240) by SATLEXMB04.amd.com\n (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2,\n cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2375.34; Tue, 21 Mar\n 2023 18:59:50 -0500" ], "ARC-Seal": "i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;\n b=cTmaX0BFbyriG1tJ7buCdctq7tZjCYkJpeNPrySSk+O6B/EeYsZh6q9QnEFBJmQ8gn9bCvUCipR4g0/r1HYypVzZYXB5AWt+YVJAeh0yGFnohXD50sT35FzwIhFCkj2hyGgbvF8dLkiRRS44Npf4b13cVOWgT1rCpb38wb2UEcOu7cHVEz9qYiInavUKjVG4FRULpvBx3qG092vkb8bhaPKVvdyaYwmgq7YHqTQY4taSP0f+nNQVuoWu6+954ciAI3hUXGJpLD9wfVeLu9tH3VGQbQYbs8w9eACwh5Xs8M1UQ/Kh3UHKpx+0vSPlMYOZIKjQBkoZ0cqWDUWdf3VyyQ==", "ARC-Message-Signature": "i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com;\n s=arcselector9901;\n 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;\n bh=9MoImANXvBp+xDfOMfoGNr+g9S1Xhuon2upQg9wWbGU=;\n b=eekjbe+fbpFJ6h/8RUV4BG70h6yM7yUTc3/jbvhTICvr09kGK6ssHBWnXgFjd8cxG1LVApOlkHRmug7xaFQsLZBlP2mMpuqHy1xaPAS4fa4daDngqr3qjETq1rtBGFEsZR5j8LxLOqbX1lrHJT1OuaIlWzfCyyQaeu8r+bpDeFAZjgCA3tz3FdU3Ivym4HXIgPHdKMw1reIzoVDhSHnEhtbXu53NejiKS+LhXitOLF0IwVwTyLG6qzm7Q1C8xZGbpG0k7zqEgLOuEloh7MDIsKiheIpt7FKOyjltK+8OfFXHATtmcF8hhkymrnwV15YjT6B39hm7ErE/A+hJqPw39w==", "ARC-Authentication-Results": "i=1; mx.microsoft.com 1; spf=pass (sender ip is\n 165.204.84.17) smtp.rcpttodomain=intel.com smtp.mailfrom=amd.com; dmarc=pass\n (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com;\n dkim=none (message not signed); arc=none", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1;\n h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;\n bh=9MoImANXvBp+xDfOMfoGNr+g9S1Xhuon2upQg9wWbGU=;\n b=bQN7XGl0tx0yVOkN3/hwb2D5ochEZRoX7I4/uoKdVNu7xh6iNkY3+Jja5uMz6QEWqXhI5kEfp+E3k+sOCoVa48WT6XCKwUPtFBvjHCVuOBBmNg1WZpgrvJT/tjfg+ca9bNUHJKQj+x+O8QO8taYqpTxpKx8MFWYbEG8tP+tx92w=", "X-MS-Exchange-Authentication-Results": "spf=pass (sender IP is 165.204.84.17)\n smtp.mailfrom=amd.com; dkim=none (message not signed)\n header.d=none;dmarc=pass action=none header.from=amd.com;", "Received-SPF": "Pass (protection.outlook.com: domain of amd.com designates\n 165.204.84.17 as permitted sender) receiver=protection.outlook.com;\n client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C", "From": "Ferruh Yigit <ferruh.yigit@amd.com>", "To": "John McNamara <john.mcnamara@intel.com>", "CC": "Thomas Monjalon <thomas@monjalon.net>, Andrew Rybchenko\n <andrew.rybchenko@oktetlabs.ru>, <dev@dpdk.org>", "Subject": "[PATCH 00/33] Update net driver documentation", "Date": "Tue, 21 Mar 2023 23:59:08 +0000", "Message-ID": "<20230321235941.2169068-1-ferruh.yigit@amd.com>", "X-Mailer": "git-send-email 2.34.1", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Content-Type": "text/plain", "X-Originating-IP": "[10.180.168.240]", "X-ClientProxiedBy": "SATLEXMB03.amd.com (10.181.40.144) To SATLEXMB04.amd.com\n (10.181.40.145)", "X-EOPAttributedMessage": "0", "X-MS-PublicTrafficType": "Email", "X-MS-TrafficTypeDiagnostic": "BL02EPF000100D2:EE_|IA1PR12MB7496:EE_", "X-MS-Office365-Filtering-Correlation-Id": "d0b26ab6-2d5b-460f-52f0-08db2a685cde", "X-MS-Exchange-SenderADCheck": "1", "X-MS-Exchange-AntiSpam-Relay": "0", "X-Microsoft-Antispam": "BCL:0;", "X-Microsoft-Antispam-Message-Info": "\n x2LwOgpRYw3ujFqbUcqrq6vF9obqRjfG9E4x/SL6ZFQyw4/zmWYCCzmIdYSg9eOUGKRX3xW8djuJSDjAyx1O7wL9c+9dCioqUJAADAECO9KQa8bWe9+BqG6T0QzQDn47st0H6+nevoDPZFSqmZQK6d5zHoC9nick2FkuLYHs9FxjaLvxHrZ6uGXXmg8a2HkjxyJw5rLoS7LB4LFv6Cly+UL5TOQg8LBJHD0mYHu94poK/XP9WlmW+Ul0byWY4gQJaaE9QpgmruGJIeG0eBilhNn+8Q294cMlByGxW2i+4K3V/Mxe2ih3kuvQMQ7YnA/NYh3vKloRnlnfCKM8EciQUChski3uBCRRxgTgEQypRq9rPFFFvTaVHHO2OlP+9ZI55/A8H4Y/zrFt/WzuQTVL304fyK3U6NkIa3FgVsIZWiDuYwn3MLe/N1WYPSjTvCs9GyGGYcHjVm1QIEclhmr7yR97oesDVZDd1/5shljN2SA/F6As24ww2+HM3KceMZ6RkFzYr/IIxqQtsDjonunkETxdk5ZkTJ9cSRmvRtGaLRQhoEPvdtSN2u4FcbgfG9RTx0EohwUCElHw84870zHk4ZqDawiHP+8zKT5pG7caJ4dXvq2N156DbEiRy+qQQU3zwkG9OOq+93uHCaPeg8B7bQtW5y34FZO1fQmFvtTbVDYqxV3GsItnSFuZNcmJc1WSM7MTcOKWYxmxDF7sSqj1CDwunjteE3rl/005b8lzpFw=", "X-Forefront-Antispam-Report": "CIP:165.204.84.17; CTRY:US; LANG:en; SCL:1; SRV:;\n IPV:CAL; SFV:NSPM; H:SATLEXMB04.amd.com; PTR:InfoDomainNonexistent; CAT:NONE;\n SFS:(13230025)(4636009)(346002)(136003)(396003)(376002)(39860400002)(451199018)(46966006)(40470700004)(36840700001)(7696005)(2616005)(41300700001)(16526019)(186003)(426003)(4326008)(47076005)(83380400001)(6666004)(478600001)(336012)(316002)(8676002)(70206006)(70586007)(6916009)(1076003)(26005)(54906003)(36860700001)(44832011)(8936002)(5660300002)(82740400003)(81166007)(2906002)(36756003)(15650500001)(40460700003)(82310400005)(356005)(86362001)(40480700001)(36900700001);\n DIR:OUT; SFP:1101;", "X-OriginatorOrg": "amd.com", "X-MS-Exchange-CrossTenant-OriginalArrivalTime": "21 Mar 2023 23:59:52.5627 (UTC)", "X-MS-Exchange-CrossTenant-Network-Message-Id": "\n d0b26ab6-2d5b-460f-52f0-08db2a685cde", "X-MS-Exchange-CrossTenant-Id": "3dd8961f-e488-4e60-8e11-a82d994e183d", "X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp": "\n TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d; Ip=[165.204.84.17];\n Helo=[SATLEXMB04.amd.com]", "X-MS-Exchange-CrossTenant-AuthSource": "\n BL02EPF000100D2.namprd05.prod.outlook.com", "X-MS-Exchange-CrossTenant-AuthAs": "Anonymous", "X-MS-Exchange-CrossTenant-FromEntityHeader": "HybridOnPrem", "X-MS-Exchange-Transport-CrossTenantHeadersStamped": "IA1PR12MB7496", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.29", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n <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>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Some PMDs has \"Pre-Installation Configuration\" section in their documentation,\nalthough section is not clear I assume that is historical from times compile\ntime parameters and 'make' build system used, where common make target was\n'install', so section refers to compile time configuration.\n\nRight now device arguments (\"Runtime configuration\") is documented under this\nsection which is confusing, so updating section name\nfrom \"Pre-Installation Configuration\" to \"Configuration\".\n\nWhile touching documents trying to keep following template in the documents,\nwith section names and order, to have consistent documents without being\ntoo strict on applying the template:\n\n\t[Overview]\n\tSupported Devices\n\tSupported Features\n\tPrerequisites\n\tConfiguration\n\t\tCompilation Options\n\t\tEnvironment variables\n\t\tRuntime Configuration\n\tDebugging\n\tLimitations or Known issues\n\tTestpmd driver specific commands\n\nNote: Patch sent as each driver separately to help review, it can be squashed\nwhile merging.\n\nOther further improvements not covered here can be visiting\n \"Building DPDK\" sections which has redundant and less useful information,\n and \"Usage example\" section which has testpmd log, most of the part is same for\n all drivers.\n\n.\n\nFerruh Yigit (33):\n doc: update atlantic guide\n doc: update cpfl guide\n doc: update cxgbe guide\n doc: update dpaa guide\n doc: update ena guide\n doc: update enetc guide\n doc: update enetfec guide\n doc: update enic guide\n doc: update hns3 guide\n doc: update i40e guide\n doc: update ice guide\n doc: update idpf guide\n doc: update igb guide\n doc: update igc guide\n doc: update ipn3ke guide\n doc: update ixgbe guide\n doc: update kni guide\n doc: update mana guide\n doc: update mlx5 guide\n doc: update mvneta guide\n doc: update netvsc guide\n doc: update ngbe guide\n doc: update net null guide\n doc: update octeontx guide\n doc: update pfe guide\n doc: update qede guide\n doc: update sfc guide\n doc: update softnic guide\n doc: update thunderx guide\n doc: update txgbe guide\n doc: update vdev netvsc guide\n doc: update vhost guide\n doc: update virtio guide\n\n doc/guides/nics/atlantic.rst | 27 +++-----\n doc/guides/nics/cpfl.rst | 51 +++++++-------\n doc/guides/nics/cxgbe.rst | 61 ++++++++---------\n doc/guides/nics/dpaa.rst | 5 +-\n doc/guides/nics/ena.rst | 60 +++++++++--------\n doc/guides/nics/enetc.rst | 25 +++----\n doc/guides/nics/enetfec.rst | 12 ++--\n doc/guides/nics/enic.rst | 79 ++++++++++------------\n doc/guides/nics/hns3.rst | 30 ++++-----\n doc/guides/nics/i40e.rst | 10 +--\n doc/guides/nics/ice.rst | 8 +--\n doc/guides/nics/idpf.rst | 8 +--\n doc/guides/nics/igb.rst | 23 +++----\n doc/guides/nics/igc.rst | 16 ++---\n doc/guides/nics/ipn3ke.rst | 9 ++-\n doc/guides/nics/ixgbe.rst | 62 ++++++++---------\n doc/guides/nics/kni.rst | 4 +-\n doc/guides/nics/mana.rst | 4 +-\n doc/guides/nics/mlx5.rst | 116 ++++++++++++++++----------------\n doc/guides/nics/mvneta.rst | 4 +-\n doc/guides/nics/netvsc.rst | 4 +-\n doc/guides/nics/ngbe.rst | 4 +-\n doc/guides/nics/null.rst | 4 +-\n doc/guides/nics/octeontx.rst | 15 ++---\n doc/guides/nics/pfe.rst | 25 +++----\n doc/guides/nics/qede.rst | 14 ++--\n doc/guides/nics/sfc_efx.rst | 94 +++++++++++++-------------\n doc/guides/nics/softnic.rst | 4 +-\n doc/guides/nics/thunderx.rst | 16 ++---\n doc/guides/nics/txgbe.rst | 12 ++--\n doc/guides/nics/vdev_netvsc.rst | 4 +-\n doc/guides/nics/vhost.rst | 4 +-\n doc/guides/nics/virtio.rst | 4 +-\n 33 files changed, 395 insertions(+), 423 deletions(-)" }