From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 92CBAA0C46; Tue, 14 Sep 2021 10:08:40 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0D1D14068F; Tue, 14 Sep 2021 10:08:40 +0200 (CEST) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by mails.dpdk.org (Postfix) with ESMTP id 3DAB34003C for <dev@dpdk.org>; Tue, 14 Sep 2021 10:08:38 +0200 (CEST) X-IronPort-AV: E=McAfee;i="6200,9189,10106"; a="218741841" X-IronPort-AV: E=Sophos;i="5.85,292,1624345200"; d="scan'208";a="218741841" Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 14 Sep 2021 01:08:37 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.85,292,1624345200"; d="scan'208";a="543846989" Received: from fmsmsx606.amr.corp.intel.com ([10.18.126.86]) by FMSMGA003.fm.intel.com with ESMTP; 14 Sep 2021 01:08:37 -0700 Received: from fmsmsx606.amr.corp.intel.com (10.18.126.86) by fmsmsx606.amr.corp.intel.com (10.18.126.86) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2242.12; Tue, 14 Sep 2021 01:08:36 -0700 Received: from fmsedg602.ED.cps.intel.com (10.1.192.136) by fmsmsx606.amr.corp.intel.com (10.18.126.86) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2242.12 via Frontend Transport; Tue, 14 Sep 2021 01:08:36 -0700 Received: from NAM10-BN7-obe.outbound.protection.outlook.com (104.47.70.104) by edgegateway.intel.com (192.55.55.71) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2242.12; Tue, 14 Sep 2021 01:08:36 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Pj9Qz3vf1HGN5X8ML+iDJ/69Wasa61ZFZfCqtgZxLo6y2eTMPdaDUne62rL5lHCytSlzMxvs08CRr5+Zx+gqCU3UJsoSR5eflbB6f9vT2nXK4OaB0GgvhXtLb14L2l7N0Ki0oAxZ7AqBZeDqacWapViv3VgMYCZFhnEQDeemeugzDFeuzTgiYxxgw5ikhfWWMHlPETvAUmAHyrGJPgczEa9vehG+6t0r/6Xz0bekFfCUMmR1IAIfUg0djEK3u9fIMo4cvtEVt5m2vvabma/1dt5dwWG9caysQP2VOLnOpAoqg8uUxwbtYUaeTzbfuUKzsYaxJOw1SppPl0tO0F4N+Q== 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; bh=nyy0nwQ1E8KicZVS9oBnLwEaeckxD5I1rdNKD+7lD4U=; b=Q795if8soNuE3Pre45d3kzNs6VRxYlRlw7iouOtl+nM/uoFyB4n4tGU38Tme9U4zVYVAlRnPwUn8YGhXkgB16NOEGjwVeze3j8/bbRCWLBL42BzZPMOyPC42nDUP3/TcAGbmiW0xOU3iaLgn0Q1W7dFPNeh4+2bJs7CwNRhJ3gAZzkyMfVrNnyNCNoMyR6tQtNxOPn1Xkql6Jxt2Kd5IJqTW5Sl7pE6C/qp1gfImz/LuEWQDP6AbLMb8ODGZcdP070lDUqi998VCb8JiaT8nacc3OeHlsexBdPVnNu3hSZ/gmIcKzwM5Qhe6NpHHcDntZqKkXcE9/pnR8emRdTdhAA== 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=nyy0nwQ1E8KicZVS9oBnLwEaeckxD5I1rdNKD+7lD4U=; b=qbx4ocWxfnD30RkfE2UFvKI2HsUtSElUcBIjyEaFbk3tI0yV0DxJ6Iebam0mGvyK3LBeGI30jFwGUSCZqGwGcwxuLeGskvJvFMXBGOQ6FJiT5sAGh6mRJUGS9lburLB2iEAi4aBd1IXXRX3A+SaU9uGVXQUpTPjhhr3UVOpyS5Y= Authentication-Results: monjalon.net; dkim=none (message not signed) header.d=none;monjalon.net; dmarc=none action=none header.from=intel.com; Received: from PH0PR11MB5000.namprd11.prod.outlook.com (2603:10b6:510:41::19) by PH0PR11MB5128.namprd11.prod.outlook.com (2603:10b6:510:39::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4500.16; Tue, 14 Sep 2021 08:08:33 +0000 Received: from PH0PR11MB5000.namprd11.prod.outlook.com ([fe80::747b:3a08:d1ec:31fc]) by PH0PR11MB5000.namprd11.prod.outlook.com ([fe80::747b:3a08:d1ec:31fc%5]) with mapi id 15.20.4500.019; Tue, 14 Sep 2021 08:08:33 +0000 To: Ben Pfaff <blp@ovn.org>, <dev@dpdk.org> CC: Thomas Monjalon <thomas@monjalon.net> References: <20210913183344.1513132-1-blp@ovn.org> From: Ferruh Yigit <ferruh.yigit@intel.com> X-User: ferruhy Message-ID: <d6bd69f4-cb69-a2e9-f2c7-c2977c0ec4ff@intel.com> Date: Tue, 14 Sep 2021 09:08:28 +0100 In-Reply-To: <20210913183344.1513132-1-blp@ovn.org> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 8bit X-ClientProxiedBy: DB6PR0802CA0040.eurprd08.prod.outlook.com (2603:10a6:4:a3::26) To PH0PR11MB5000.namprd11.prod.outlook.com (2603:10b6:510:41::19) MIME-Version: 1.0 Received: from [192.168.0.206] (37.228.236.146) by DB6PR0802CA0040.eurprd08.prod.outlook.com (2603:10a6:4:a3::26) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4500.14 via Frontend Transport; Tue, 14 Sep 2021 08:08:32 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 4c0eb1ba-581f-4ffd-c6ab-08d97756d87c X-MS-TrafficTypeDiagnostic: PH0PR11MB5128: X-Microsoft-Antispam-PRVS: <PH0PR11MB512836E792CD0B79105F503195DA9@PH0PR11MB5128.namprd11.prod.outlook.com> X-MS-Oob-TLC-OOBClassifiers: OLM:9508; X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: G0K5fTHohqskTg9xz7/8LEUXFHGoB4PHYuKKI0IuGsM84LYe8gO+sIEyZvyl2E8ozXI1QCnFfzwrFe5kV8NpNLIfhN9GO/oS0UiCTxaTkgpUfPjtkLCS1Jz/JgxDtXkoLyENHJuCwlhHjutQBo61JLIwyPQamcst/DLsus1fTNT5JjLpW/myMbswEJw91oqW7Dt2DN/q+4ms4BG4F2RH2H3L/D9lv98zEPgcDmbdKPJz3vaVSytMiJ2ZeVLAR0MmcPYQqbWuHh6GKh3mHntcAIgQ0DigtUGRuA/f+s/KyYgKrBML3VjBhjXNREcNK/g3L2SMuz2UrgxWHqCzFTlCvZhZX2zm4MMB4DgA784hkWkr2nG6nGY12nVqWqX8DRXnFNzt9w+AglzVtUJBvGPUin35wuaPXJJaj+BX/2zX3BG6RpvqmlP13pKYHHs8PohPZ15CzTrOBchB5aGzdM27iMYSgOdI/sSzKZZdFKHtX6rB7FKKWWjhFSe5EB5rW3boFKedimlOupHMJYOyeQ0UiNtJMiWKUw0tdHT++FgDbd2+63Qv6Ctj/E/Or0ofiZkVuUAuufCxJGrq/ChjNdYJiNbJo4Wgova2AY6YU3+tPY3vVCn+moo2O2dBrmt9/8Mq513vdp+CYTHP/cL9aAp+SU5TsXUEveWPZ4zNLC6ia4pnatGaV5Z67qPksoVgub/12moZDb3LfiGDU/uhu5l155sKag5hDlGtiou9Q94ZOeKfM8jwn6UxnEWa24pbY6svZlvYuFLJXnlsHwbt58/C+AicEHvaWx1gfPAkJe7hp7k= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:PH0PR11MB5000.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(366004)(136003)(39860400002)(346002)(396003)(376002)(86362001)(316002)(83380400001)(5660300002)(6486002)(478600001)(2616005)(16576012)(53546011)(966005)(26005)(36756003)(4326008)(38100700002)(186003)(2906002)(31696002)(6666004)(44832011)(66556008)(8676002)(66476007)(31686004)(8936002)(956004)(66946007)(45980500001); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?OGN3b2RTUzFqdUZSTGxzK2RjT29SKzVNRDhVVm5ndVdrd2t6aXRnQjhRSDJ2?= =?utf-8?B?MWZxdkxNSGxVc1hyVlU4d2M3aDcvdVNjOGlYTmpzNm54WEEyTDE4S0NBMDh2?= =?utf-8?B?a040SUdhYXJrb2VabkZvRzBsZUQwcU5EQ1RtVnNDanFseUF6NDFNemprQi9l?= =?utf-8?B?WEVKVTg2ams0NEJIUEZCdzJKalp4Q3hMbWpzR09ndjFWY093R1U0a1BDVkVS?= =?utf-8?B?STFZbWU2YVAxV0N3OXB4cFA0SWZvMHVTczJWZ2NNYjFsV1lhZWd3ZGRjSTBz?= =?utf-8?B?cUVuQjRpUVZxWi94QUdXUW1pMUVoWHAzZzBUcHYrOHluLzI4Mkc1TkVHVEk4?= =?utf-8?B?dlg2ZWVaaDF2NzFpZUx4UElUYkRtb093TzZVQ21hOVBncEtGRFFCc3UrU2k2?= =?utf-8?B?NHFCeUVZdGZudDlPbEQ4TlNVekkyWlFubkQyN0txZkQxcCtYeUNleTJldVVU?= =?utf-8?B?VUlBbnMycVNDOWQ0cU5kZVp4RVZ6QlJyRjlLb3NTOGVPTC9qMCsyKzQ0eE9s?= =?utf-8?B?TURqNXlYMWlSMTFzalNNM2V4Uk51WWozQ29tb2R6NnNjUk5PZDlwemtDYmVY?= =?utf-8?B?REd4Wk15S1NsSkVWRVAyeTU5dzlSRW9JUHpDbktJdEZFLzZWejhPM2Rwc3VC?= =?utf-8?B?ZUVNZ3RGQkwzTkM0M3J4NXBvcU5LK2thV29LL0ZmcDE0bFZZUHNOYkJRMStO?= =?utf-8?B?WTVhZVBMWEVDWWRkeGxNTGYyRWF2Wkp2OHVVMU03MVJzZlFjSXFxZEpnS2g4?= =?utf-8?B?UkRSRStNcmZlNTEzalVkWHMyanV6dWdHS0JaWHZDYlFua1hzenpoMW1xbENj?= =?utf-8?B?bXNwVUZoWGkxVFdjcWdwTVZHeDdNc09OQlJOZ2FKR20yYzJtWkE3cVJEZ1ZM?= =?utf-8?B?T05OOVgySTRTWFFYMHZkZXpaUXFBbG9GdmRMVzBlZHgwM2MzTmtMTXJiMlg1?= =?utf-8?B?b1ZoQk5BYjR6MHR6Q0dTblBQYnNQTmhnb0dRSUlkc2VBNWQzRVRNMzlQUGVx?= =?utf-8?B?NmFhVG80bXlLaEZoQUljUit0Z0hqWGVST2phVzdzTXhnWXk5dEN4eXdtQXBp?= =?utf-8?B?OEVDdVFZZHIxcG16YW8wQTNjV0RJVkd3WXVpV01WZ09adVppUk5LaW1LYW5k?= =?utf-8?B?eURURndFdWt1cDgrRzZ5bXBZNU5jSlEvTUNEckVLb3pUNXpTVmVVV1RUS3VC?= =?utf-8?B?S21hV2lYdXVXZFpESndOQUtXSE9XMkI5NjVHWnJMb3EwUDh4SHQzREVBNWR5?= =?utf-8?B?QWdGd0k4blF5WXJzV21Nd1hIWG9OMVM4YVhMNzRVR3loSkp3RzlFUURGM2Ja?= =?utf-8?B?VFpwQUlBUVgyZHV3UjF4MzhOYVV2QW4zb1orRkw2WVR3S0FFdHJGUStJc2xW?= =?utf-8?B?ZEhBazlEWUFra2dFT3VoVGJMa2hMQTU5TGlDZnhBQVFKbFNVdEVMaTZVUGNL?= =?utf-8?B?cXhBTUdnSDNTR1l0ZjBlRG9GaHJyU1RRQ3pWcmNENU53UHFMZDNsVE9CT215?= =?utf-8?B?emNvU2xqaTZ3OFhuR3FIRDFGbTlqM3RLb2o0T21UZm9OS09HMFRoSkI1Z0Rk?= =?utf-8?B?a1o3aUJVWVE5RVJ0VHNRTFJYWnRhbERYYTMvQTl2WkJMKzRNbURMWklFeGwx?= =?utf-8?B?MkJPTGZISEJVbmRaT0RoV3UvMFNaakR0TFRZWE11T0poZGh3UkM3STQ3R2dy?= =?utf-8?B?M282TnFaVjVuY1VPNVFaVUt0L0JtQzBzZEFrRUFkcFFKZ0NPblNtUXpTTGVI?= =?utf-8?Q?Vvs0Hdc3+2ZVCHUtWvMp/PmpkgQ8gdkgaSKndgx?= X-MS-Exchange-CrossTenant-Network-Message-Id: 4c0eb1ba-581f-4ffd-c6ab-08d97756d87c X-MS-Exchange-CrossTenant-AuthSource: PH0PR11MB5000.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Sep 2021 08:08:33.4536 (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: dgthN/kgpqsJQCxQNP1+A6N2l73rsTzxkQ0wHi8L6UA3t512zmx7RCyM4oFCmq3KTe8FCxlkDhl68Kzcs+IA9w== X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH0PR11MB5128 X-OriginatorOrg: intel.com Subject: Re: [dpdk-dev] [PATCH v2] app/testpmd: Document what the application does. 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>, <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> On 9/13/2021 7:33 PM, Ben Pfaff wrote: > I could not find anything in the documentation that says what > testpmd does. This should save other people time trying to > figure that out in the future. > > Signed-off-by: Ben Pfaff <blp@ovn.org> > --- > v1->v2: Revise introduction instead of option documentation. > Thanks to Thomas Monjalon for advice. > > doc/guides/testpmd_app_ug/intro.rst | 10 +++++++--- > 1 file changed, 7 insertions(+), 3 deletions(-) > > diff --git a/doc/guides/testpmd_app_ug/intro.rst b/doc/guides/testpmd_app_ug/intro.rst > index 5d8d8cf4eb..1129f53c62 100644 > --- a/doc/guides/testpmd_app_ug/intro.rst > +++ b/doc/guides/testpmd_app_ug/intro.rst > @@ -6,9 +6,13 @@ Introduction > > This document is a user guide for the ``testpmd`` example application that is shipped as part of the Data Plane Development Kit. > > -The ``testpmd`` application can be used to test the DPDK in a packet forwarding mode > -and also to access NIC hardware features such as Flow Director. > -It also serves as a example of how to build a more fully-featured application using the DPDK SDK. > +``testpmd`` is a tool to test ethdev NIC features, including NIC > +hardware features such as Flow Director. It receives packets on each > +configured port and forwards them. By default, packets received on > +port 0 are forwarded to port 1, and vice versa, and similarly for > +ports 2 and 3, ports 4 and 5, and so on. If an odd number of ports is > +configured, packets received on the last port are sent back out on the > +same port. > Ahh, I missed that there is a v2, I already commented on the first version. Just to summarize here, I think documenting a specific forwarding engine and specific configuration of it as what 'testpmd' does can be misleading. What about making it a little more generic and provide link for more details, like: https://doc.dpdk.org/guides/testpmd_app_ug/testpmd_funcs.html#set-fwd > The guide shows how to build and run the testpmd application and > how to configure the application from the command line and the run-time environment. >