From patchwork Mon Jul 3 07:58:27 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ali Alnubani X-Patchwork-Id: 129187 X-Patchwork-Delegate: ferruh.yigit@amd.com Return-Path: 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]) by inbox.dpdk.org (Postfix) with ESMTP id 557B142DC0; Mon, 3 Jul 2023 09:59:57 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D9CF840ED5; Mon, 3 Jul 2023 09:59:56 +0200 (CEST) Received: from NAM10-MW2-obe.outbound.protection.outlook.com (mail-mw2nam10on2079.outbound.protection.outlook.com [40.107.94.79]) by mails.dpdk.org (Postfix) with ESMTP id 993A240156; Mon, 3 Jul 2023 09:59:55 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=HzS9oiDcJ6BINmD0b7Q76dqIuM4vM0sJQ9+EaQJvgi9RHTqEM0wClhkuXYU6amS9maCZ8e4jG5GLCZMgYkn5q3vO31Govb1yO43PoEJZM/VbmiGGuwRb8xHzCcm6RAlaKbr5Cr5MDL65NGQSpTFr8JNANseyrGyQFoR3qJffso2gOwIsVO0zcWj/D7EYEZ/HgHceUJJwqPAufsIfo795lvJRw9qQirQL0CHcumwp8ZyqMbMG+R7vi0a6pxDmLIhxkvgdJUhS/LuT5fQo0XS3mKTauIjvOKGqWsVrmLJrdAgdifv+S7xiW+QK1nlOYK33o9mCkdItFfAgABBZG8nKbQ== 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=i25qweqGd/sbqXpVraV7MyT8HmKJ/IXyIU9zBEiHpjY=; b=TIwMhDV8C4e6FwpEHM3CH8JURMuNPRUokN3NwrjIW4K8hGEqQcCamW/97tJq2t0DL+kUozdKXDSlWacRIAd4MzqkTeI7uW0gLyjbn71OF6UQy8zBBPdACwOPnrfSx2gs8R35eMoCJwqzZCYxNPocxEhEHLus+V6r/IfMl1ZBc4DniYlKcn/rcFxpRox3GRr7otc82K8t1kFC3dshuTZrdy949ifAimrbJ5o/dg2bodMy89JmWumC9Ftncpt2ssgF1hdi3EVvo6OPTyDcNwszyJp+RRyRSN+leeoq7Ewys7Imtw3VkRIKZg0tK9fHFiDmWYxqyXoKqRSLMo/y9URezA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 216.228.117.161) smtp.rcpttodomain=dpdk.org smtp.mailfrom=nvidia.com; dmarc=pass (p=reject sp=reject pct=100) action=none header.from=nvidia.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=Nvidia.com; s=selector2; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=i25qweqGd/sbqXpVraV7MyT8HmKJ/IXyIU9zBEiHpjY=; b=Uuka0BinQVSePnKUnANRQghlGmg/bhZ/FTpYg3zdyUyx8PG/h9+Ek+n+KZiLhRPeQA/PX33tYjCm9fxtdzqK1Eyn/Rs1mwDnKrAM1bNOOFnjD+S8oXDniBHIHD5bpPkNhlSumt4W3/Cvue09VjaZiqq6Mu3J6aiI2UICfZJ/IUn6BmHAycne11EBHimUitC0Scgi83WwPdTiZAL7zXPQPnGmgc0zoxir7rdZPUGUMgsuneqn2FCu9LM4/xjC6ogH9OtthVil0UERO+TC8UYdTTw27kfRmfNPOosVZhwbAm54ZaKSrBY3oFR0o3Q0tMEZ8IZHgtWelfgEdXMazBEgkg== Received: from MW4PR04CA0323.namprd04.prod.outlook.com (2603:10b6:303:82::28) by CY5PR12MB6480.namprd12.prod.outlook.com (2603:10b6:930:33::6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6544.24; Mon, 3 Jul 2023 07:59:53 +0000 Received: from CO1NAM11FT035.eop-nam11.prod.protection.outlook.com (2603:10b6:303:82:cafe::8f) by MW4PR04CA0323.outlook.office365.com (2603:10b6:303:82::28) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6544.30 via Frontend Transport; Mon, 3 Jul 2023 07:59:53 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 216.228.117.161) smtp.mailfrom=nvidia.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=nvidia.com; Received-SPF: Pass (protection.outlook.com: domain of nvidia.com designates 216.228.117.161 as permitted sender) receiver=protection.outlook.com; client-ip=216.228.117.161; helo=mail.nvidia.com; pr=C Received: from mail.nvidia.com (216.228.117.161) by CO1NAM11FT035.mail.protection.outlook.com (10.13.175.36) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6521.43 via Frontend Transport; Mon, 3 Jul 2023 07:59:53 +0000 Received: from rnnvmail201.nvidia.com (10.129.68.8) by mail.nvidia.com (10.129.200.67) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.5; Mon, 3 Jul 2023 00:59:37 -0700 Received: from nvidia.com (10.126.230.35) by rnnvmail201.nvidia.com (10.129.68.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.37; Mon, 3 Jul 2023 00:59:35 -0700 From: Ali Alnubani To: CC: , Subject: [PATCH] doc: fix typos and wording in flow API guide Date: Mon, 3 Jul 2023 10:58:27 +0300 Message-ID: <20230703075827.503040-1-alialnu@nvidia.com> X-Mailer: git-send-email 2.25.1 MIME-Version: 1.0 X-Originating-IP: [10.126.230.35] X-ClientProxiedBy: rnnvmail201.nvidia.com (10.129.68.8) To rnnvmail201.nvidia.com (10.129.68.8) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CO1NAM11FT035:EE_|CY5PR12MB6480:EE_ X-MS-Office365-Filtering-Correlation-Id: 65d2f55b-48e5-4c9f-7202-08db7b9b7c12 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: tA2EYrCeTVWW9epf8vVpQw+330Ui2sZfW1uyONtoniA/SJNPWblZHDcs5s6xs7vdk6A4g61DdqgDAD6cQGAHyQ82dJjLxWq5KkjQsHpHhlOlLiJ+XRNUzowJD49TJTccdhh6nDYSR4T2Gq/8xe7WpzU8Hy3xEWwGj1x9rIj7so8AGGYsUlaDv2JDkPZJdCOlAb1OvJSCaxwU5P3aKKhKU8PH4D0lEe3bgArmZgq7xQew01jjwU9aMjuU4F44iSzY9f9vRfjHUTApRuFLnUYs4yjTf4Zvcs8rK2aSgKj+KNk3iGaLmn4osNUk4oQwcAnSRIN9gTJJrU1bk6avltg2GIlDgoQiesvnG+g+njLTX9T0xfw7s5lmxcd8muUAjKa7LZgtRmlrAajkf7md7wt9SDruzQVk9/VJj3Oi174sNeJ+YCwKGLu23n/LRPYpIy3apU/Fr0ABxPSpjGBm4gS4IEB1dGcQamCxYuhQVOnhYG+JzMtwHCQJhZJ7GOSBgwtkgaGs9orL4HmjH7May3WbTD6Wg5faP5qg4c9Dw25rMZEcTdZ8LH2oE089aCwylPi6y4aGAw6QaekgsYtaRDzvVWkuv9Q7ln0XR9DmgiN1QjDHKtAzXLzm40O0OmUge/qXdBYzPJYVmMij5mkc9WpqUWhMODzrD0bV8t08mkRM5tY+DbwhACAJHb9rYnChmnjugY5KRKn50+IUn7C0Fwrg9PultxQ+KUkiHgJ0LsXl6mqNZ8qg1ZSZ6nCnDkmZZSxg X-Forefront-Antispam-Report: CIP:216.228.117.161; CTRY:US; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:mail.nvidia.com; PTR:dc6edge2.nvidia.com; CAT:NONE; SFS:(13230028)(4636009)(376002)(396003)(136003)(39860400002)(346002)(451199021)(40470700004)(46966006)(36840700001)(6666004)(2906002)(7696005)(82310400005)(8936002)(54906003)(40480700001)(8676002)(36756003)(55016003)(41300700001)(40460700003)(336012)(426003)(36860700001)(5660300002)(478600001)(70206006)(70586007)(6916009)(186003)(86362001)(16526019)(6286002)(26005)(1076003)(4326008)(316002)(47076005)(7636003)(356005)(2616005)(83380400001)(82740400003); DIR:OUT; SFP:1101; X-OriginatorOrg: Nvidia.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Jul 2023 07:59:53.3225 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 65d2f55b-48e5-4c9f-7202-08db7b9b7c12 X-MS-Exchange-CrossTenant-Id: 43083d15-7273-40c1-b7db-39efd9ccc17a X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=43083d15-7273-40c1-b7db-39efd9ccc17a; Ip=[216.228.117.161]; Helo=[mail.nvidia.com] X-MS-Exchange-CrossTenant-AuthSource: CO1NAM11FT035.eop-nam11.prod.protection.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY5PR12MB6480 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 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 Acked-by: John McNamara --- 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