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 1D44242DD6; Tue, 4 Jul 2023 16:05:48 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 54D9C42B8C; Tue, 4 Jul 2023 16:05:47 +0200 (CEST) Received: from NAM11-DM6-obe.outbound.protection.outlook.com (mail-dm6nam11on2043.outbound.protection.outlook.com [40.107.223.43]) by mails.dpdk.org (Postfix) with ESMTP id AC93840042; Tue, 4 Jul 2023 16:05:45 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=K1yKXuWFKf43sgBw1jSW2pFhG3O/Xl62TpxLBUZfD1mQcevipLtOgBjaRqLjNvAGR/fBmUnB2YTg39ovDuX8Wfj5AgLDIZJV2piY4iGXBroj0G6KJjIbIRoz392orBGxnRk5FSFMByEksmVLdUxLJiESHk4xcwH4Qu0m62kZ/5D0lnbAe8WreC0Grhq3IgFxnKiwsPSctv8X+6vdlMgRLT/LM5XrmpEoBG07wN3o01v8oeMVv1Ij8H6OHr/uJTwbKzbilGk7GwSQwaM/mbvaK9uVTfcxFBkjYDedCBrThbrz1jpVYPNB2Er9tsbXHS9HIXqaNEI+IX8E+Pj2/1aE0Q== 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=2piuYasQ+jSQsb07TbArnRUJrTfyiehxlJm6IBP7FvE=; b=f06K1JGhxvMaMivSCiy4M7pCTURaEN7bIiJabbsu3n7Nop/Ci5B6MGR3rUctTJwqYmHpApWqA370NaMYWbmNa70s3mcB5ZuqPjAHWsqS54aJ66XL3d7IfJajrX6fGyo5uVIX79dBinGELh9TICqF487IEPRyMZ15lTMvYW0ic8LNcYczI/jdYpLaPwy1mLD0+NP6aP27z6sQyXRMwCaMnWRPoJ08JthYEheEf9C08yWSaEkfwtAeUgP3kZY9mN4FEVpLxOT3ZkChpEF77O0cmVteBrbPVLnvMwNJqcP44A5qhY7eGU7K56VEGWbB4pmY9fvefsOEyhgL0Zw553GrHg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=amd.com; dmarc=pass action=none header.from=amd.com; dkim=pass header.d=amd.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=2piuYasQ+jSQsb07TbArnRUJrTfyiehxlJm6IBP7FvE=; b=bcQ6nmVtKku0ZN4pz+upBGNi6jYcSoAidfDy2CBM/mjUgQzfI7xC97hdq5EX6y3gArv9wUnHsM4YYqLOPNg/nz+5b22bE5ToMvRihd2m1vbQP21mkCzn93z8nwNox2Uf4zzMycdrv9/fmy3XqydX7wW/+eCqg5LBxOTC6VsoWm4= Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=amd.com; Received: from CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) by IA1PR12MB8359.namprd12.prod.outlook.com (2603:10b6:208:3fc::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6544.24; Tue, 4 Jul 2023 14:05:42 +0000 Received: from CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::16e3:326c:5c2a:be42]) by CH2PR12MB4294.namprd12.prod.outlook.com ([fe80::16e3:326c:5c2a:be42%3]) with mapi id 15.20.6544.024; Tue, 4 Jul 2023 14:05:41 +0000 Message-ID: <70019968-7423-71b7-469c-c0fc0bad01c5@amd.com> Date: Tue, 4 Jul 2023 15:05:34 +0100 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Thunderbird/102.12.0 Subject: Re: [PATCH] doc: fix typos and wording in flow API guide Content-Language: en-US To: "Mcnamara, John" Cc: declan.doherty@intel.com, stable@dpdk.org, dev@dpdk.org, Ali Alnubani References: <20230703075827.503040-1-alialnu@nvidia.com> From: Ferruh Yigit In-Reply-To: <20230703075827.503040-1-alialnu@nvidia.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-ClientProxiedBy: LO4P123CA0589.GBRP123.PROD.OUTLOOK.COM (2603:10a6:600:295::17) To CH2PR12MB4294.namprd12.prod.outlook.com (2603:10b6:610:a9::11) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CH2PR12MB4294:EE_|IA1PR12MB8359:EE_ X-MS-Office365-Filtering-Correlation-Id: cfb1708e-750b-4483-8b79-08db7c97bfc1 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 0DxPwlqz5/T8Wr+vVKQCU9f6LFDRQs9n2TEFkd8F1S5fsRAigy/gY9arzZycxinblCjRvP44/llE56YRvIjMtlRKdE+9z8GcWISXN21PH/MZdoPyGKY+iZ3zBtYsRR2uFGzs01RicBlPAbycq9avuU081RBpkotdb0l9xU5rVZ60CX+2bTG108RPLBGE7fMd5oRz5SbDknkZWoT+gCO8EO3fLENkT2ECrrOqMIcbhWols7V2ZQBhLtQOvxP9+pD/O9HRFpuDdpjIx7c/ELMco4Iv34Aik9l0fkoxJCv2fG86zarQ33yLqbyCtvH76bmqH4yLdaRmFUAImnGny1+BNed03xK4PFVnSnmU13v0hMozjxeMn1eXWcIws1WFfDUKOunU7PBE+ljuF7m5nb19snZuCT3a7/EIGH+IVtHMv9KBZpxMn/t/w0RJGIYSD35B0+HdzIZuUbE8mfzleKgmwHje8p4Br8Gu+VJnozVzo+4qSNKKMnp+gwD9iHPctr16sTfIttVg+4gDClEjCWexChLgtaK/ugEocqe3RDbbvNkT4vNL/XOWCi7LgOSrWq0CoQH8+BavDLjy9WwY/U5qBp3oF8bR2IBLtjual3/DZwX/Y3hdVSUwgjGWWDy+39dkUw376ki/a0/PfIzsZcz9fw== X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:CH2PR12MB4294.namprd12.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230028)(4636009)(136003)(39860400002)(396003)(376002)(366004)(346002)(451199021)(6506007)(53546011)(6512007)(66556008)(316002)(66476007)(4326008)(66946007)(38100700002)(6916009)(83380400001)(2616005)(186003)(26005)(478600001)(2906002)(31686004)(8936002)(8676002)(44832011)(36756003)(5660300002)(31696002)(6486002)(86362001)(6666004)(41300700001)(45980500001)(43740500002); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?NGpGaUxWd3JNZ29KT2wyRlNwYUF4ejRXSWxUTG85T1hZV1VEdXBkRGZuYWpo?= =?utf-8?B?QzVvcEJiZmpETHNDZnk3OHZLQ0NSN1gvS2FTUFg0d1hkdS9TTWFpZFlBLzhu?= =?utf-8?B?NVgwN2ZkRjgxam9UVndqVWU0cDFuUyszbWRDRTJOYmh1dFQ4Z2s0TksxMEI5?= =?utf-8?B?MWJycVJ2M2NkZzFUdkJ6cTFXM3FWUXFNeXJOeE5sRG9KQlRyTEEwajBLS2Ji?= =?utf-8?B?V2pqaS9PTUx4WGpOeTBxSW44NmVFRFVYd1IreDM2Z2pwYWFPZjdJVkxtMFhP?= =?utf-8?B?QWphVmQ3QS9tR2RodDJBU1BNMURXVEZNY1lra1o1RHoxdFU5ZXAyeFBBc1lS?= =?utf-8?B?cWtJRGt0MmU5ZDFpQ0RKYW9YOU9XYUgrQ0dmVGZIdXZMMENiT1hxa3QwUmRo?= =?utf-8?B?akZvSnY1Z1BLcE1Db2gwcDBObytnclA4Z0h2UWVNZnhFTVRCT0F2ejl1WWxJ?= =?utf-8?B?ZEtUMTUzcFdZNnQ4bE52a0N0R0ZTRlljS2ZZMnUxUHVMRnd2cEs5UitYRTFj?= =?utf-8?B?ZW55QzlkQlJRN2h6VUpoSHp2cUF6Zm5weERTUlh5Sjk1RGRkcTNkaFZxcFl4?= =?utf-8?B?YWxiUW5yWkdZZ0NQSEJWd1d5WDRJd1dYQnlsUGp4RUFsclRLTmdsTEovSHZO?= =?utf-8?B?TzZsRTBMZVlaUFJjSHNXU0NwVTBxdFNiN09xS1RUVjg1OW1NV1BQc0xlTjBK?= =?utf-8?B?Tk1qei8xcXk2R0VIWWxOaVFBYVRZUCtKeHF6NzhpbGJTNVYyOU1VTWJ1N2Ur?= =?utf-8?B?S1dvU1VmdjhpM3hlMHN2RWZ1dEdOWWFBNzZsTHZJK0RTbkZUd01TcFcxalZU?= =?utf-8?B?K3RsZWR2MkhZMnp5TDFkVml4VDh6WjV5dGVMSEczU3JtK0luWmx4eDBTcllJ?= =?utf-8?B?YWgvK2Z3VlByOUxMTW9ERmdNU01DRzRMT09OMFQ4cWVBRVdNRWREQVhNZXB6?= =?utf-8?B?RjNPSWF4K3pXczdaMGt3OVI4OE1ZOHBwZUNtQ1JCTWl2czdRWm5ORUZGUUhG?= =?utf-8?B?cUQ1eUhhSi95NmEwMlI0N0tzRjVJR2VRN0FVRGhWNUtIc05VT1V0MHRnUzk4?= =?utf-8?B?QUJOZkFEWFpQWFgvK0RneEhUZGhKcVZDcHI4ajllNFZvWCtGYlZWSTRaRXhl?= =?utf-8?B?NzFLZGhZU3pCdXcyQ2E1Z1JVK2F6UldlZ0IyaG03S3NPYmRoUkZhemovU0tY?= =?utf-8?B?OTdpcll0NWVTNzFSamU2elVpcWJueG9ZZVR2WC9oT3FoWHZrQUhzVVlvWEh4?= =?utf-8?B?dnkwd05IcHpSTzlhR3pZd2lJNndjTkJ1bHVQNnphV1JLOWt2Skl1djVxZEh3?= =?utf-8?B?SThpZnF5TUVtTlIxeE9SOVVwL3Y4bXVwRlNJWGJxeVZYUGk1WFNtZjhZR2VI?= =?utf-8?B?OExzYnBKQSttaUk0MU5pVEZSdFl1QWlNSFBKdThaSHc2cHNDK0xJMnhHd2hS?= =?utf-8?B?dUtMUU04QzRlV2VVRDdBRmxmdHY1M3d4bXAyT1NPM0NNZ1MrbUFKTmxZVHNy?= =?utf-8?B?NVFLVDNlOHV3MXdHaCtCNHF6QlFIZVczVytZa25mK2tUMnRmT1IxRVM5N0Z1?= =?utf-8?B?dDlyWHU2d0lvV21rUEVVa2tSZ1I2bEkzNENWcGZxaU5FZUpQalRWN3h6QUYy?= =?utf-8?B?TjhIdzZwcGM2NndRT1dzZkNDbWhHZEk1L0N0YVVZZTFwQnhEbFBlVjVlZVdM?= =?utf-8?B?aTBSWnhkMkEvNmVWK1kwZi83Y2g5V29lSlhIVU9zNXhhS1RkMjM0Z2REL1NV?= =?utf-8?B?dWFCQzhoVGFNSm1vdjRJMzMvaW9NQlc1RGpDN1FlV0NYK2hiNFkvRGEvaDQ2?= =?utf-8?B?WUxobjZESCtsTjJLYjNpVjNVWG5zUnRmczlCdHNUSlQwKy90bGhtU3g2dklQ?= =?utf-8?B?ZTkrcUZRY3RnR09QOTRHN3lLMVl5VnV3c2g1STZaTHhNb0ZqdEtrZUZzdmRr?= =?utf-8?B?UW1CMlVoNTB5Vzd1MVFOaDc5VURUVTg5WTNkVUpsYUd1WDcwZmYrTlo0emw1?= =?utf-8?B?aEZYTHdKRGRoVXVtUU56RGt0eWtRalAzOEdNMG5xdXNybkUrcFI3TFBXT0NB?= =?utf-8?B?VVdncDVML1Q3TVZRbWZaMnFrUThSMHhwZmRkODUwZGdHanhIN3NaWUtJaHJF?= =?utf-8?Q?aq10CyQvcLjj9e5VdOWtYsnFz?= X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-Network-Message-Id: cfb1708e-750b-4483-8b79-08db7c97bfc1 X-MS-Exchange-CrossTenant-AuthSource: CH2PR12MB4294.namprd12.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Jul 2023 14:05:41.0251 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: E6O9x6W3i80cj85gfoKLjMInMcwRUhZtuJyJtrMLlmwN/oee4sVYoCz9cY3d3j2N X-MS-Exchange-Transport-CrossTenantHeadersStamped: IA1PR12MB8359 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 On 7/3/2023 8:58 AM, Ali Alnubani wrote: > This fixes typos, punctuation and wording in the rte flow API guide. > > Fixes: 2f82d143fb31 ("ethdev: add group jump action") > Cc: declan.doherty@intel.com > Cc: stable@dpdk.org > > Signed-off-by: Ali Alnubani > --- > doc/guides/prog_guide/rte_flow.rst | 16 ++++++++-------- > 1 file changed, 8 insertions(+), 8 deletions(-) > > diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst > index 32fc45516a..6dbf5ef0a4 100644 > --- a/doc/guides/prog_guide/rte_flow.rst > +++ b/doc/guides/prog_guide/rte_flow.rst > @@ -148,14 +148,14 @@ Attribute: Group > Flow rules can be grouped by assigning them a common group number. Groups > allow a logical hierarchy of flow rule groups (tables) to be defined. These > groups can be supported virtually in the PMD or in the physical device. > -Group 0 is the default group and this is the only group which flows are > -guarantee to matched against, all subsequent groups can only be reached by > -way of the JUMP action from a matched flow rule. > +Group 0 is the default group and is the only group where flows are > +guaranteed to be matched against. All subsequent groups can only be reached by > +using a JUMP action from a matched flow rule. > > Although optional, applications are encouraged to group similar rules as > much as possible to fully take advantage of hardware capabilities > (e.g. optimized matching) and work around limitations (e.g. a single pattern > -type possibly allowed in a given group), while being aware that the groups > +type possibly allowed in a given group), while being aware that the groups' > hierarchies must be programmed explicitly. > > Note that support for more than a single group is not guaranteed. > @@ -170,7 +170,7 @@ Priority levels are arbitrary and up to the application, they do > not need to be contiguous nor start from 0, however the maximum number > varies between devices and may be affected by existing flow rules. > > -A flow which matches multiple rules in the same group will always matched by > +A flow which matches multiple rules in the same group will always be matched by > the rule with the highest priority in that group. > > If a packet is matched by several rules of a given group for a given > @@ -1755,12 +1755,12 @@ flow group/tables on the device, this action redirects the matched flow to > the specified group on that device. > > If a matched flow is redirected to a table which doesn't contain a matching > -rule for that flow then the behavior is undefined and the resulting behavior > -is up to the specific device. Best practice when using groups would be define > +rule for that flow, then the behavior is undefined and the resulting behavior > +is up to the specific device. Best practice when using groups would be to define > a default flow rule for each group which a defines the default actions in that > group so a consistent behavior is defined. > > -Defining an action for matched flow in a group to jump to a group which is > +Defining an action for a matched flow in a group to jump to a group which is > higher in the group hierarchy may not be supported by physical devices, > depending on how groups are mapped to the physical devices. In the > definitions of jump actions, applications should be aware that it may be > Hi John, Can you please help reviewing this patch?