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 7352442EC5 for ; Thu, 20 Jul 2023 12:59:06 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 7058240E2D; Thu, 20 Jul 2023 12:59:06 +0200 (CEST) Received: from mail-wr1-f45.google.com (mail-wr1-f45.google.com [209.85.221.45]) by mails.dpdk.org (Postfix) with ESMTP id 0E99B40DF5 for ; Thu, 20 Jul 2023 12:59:05 +0200 (CEST) Received: by mail-wr1-f45.google.com with SMTP id ffacd0b85a97d-314319c0d3eso583837f8f.0 for ; Thu, 20 Jul 2023 03:59:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1689850745; x=1690455545; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=so9kw67K9tmyvFrrpLfh6VNCB0RbEjGDiWQMFBe5XKk=; b=Yfh9fxyVNjn3jvtFE+xwD5KSX4yB7PCG0KhmlXUPA9FjnyLvrBu2tZnAQ0cm/zFNvw eDYJtdiuE5bhv6uUU/78BQdUn+k+0w+s3zvWwZAyxC/C67neVU9Hxm0oepr2rO5P0WIA Aa/NQ7HxOevyQujy40KyqisWkPxRbe1yMxUQSk5D2FP1wrvIdYmAT5IhilXdVuPU10I2 1QW3lxzrCv/euEXCDHWHM5JuxTM+mQLW6/EB++7Dwx38rRX62B6vYhZu/svujEojttQk iB++l5BE2MhPQU565OBSr6PogFvaUaX6nLOFVpFput7Ikr2A7GyKKKM66jw2Vy9cIK2D bm3w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1689850745; x=1690455545; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=so9kw67K9tmyvFrrpLfh6VNCB0RbEjGDiWQMFBe5XKk=; b=i0c8Z4+RZxq36KrVZJhUlH25VzypXNDc9UPwJTPmg2MGT2VJJSZdVph20jguDspUNn l9Vzza0t7noWzQ3VeZQeWi7ZbwLJansDOutqkg56a7WAEvbahFbIXcvt+4UUfYgJUnm3 SM/arj6kSj9PM6MNHpBkAXzsrqU/oDhR9bybrm9gS9BC2VfV+q/lCGG59YHr0UeNWWdM Z91PIlU+/RKY1cE2YXJWiLQokAotliQsMctfSyKagf/8J+mhfMmcjOmSBxKBbFiG5wmA IOPLydF8XyOUSsnr2dsKy6LEVgjtUODzvCAAp0PtyCnQmLZ0GgSvF2oh03OhR3uY7/8Z AY/Q== X-Gm-Message-State: ABy/qLZSGYfJbo01WztTsAaMAmSOCN7uoq8/OYW+S5AxIgZxBy7DC0RV TRUPiLG7Dv+fZmGZlqGcWOYfWlX5Zf8CK+0Y X-Google-Smtp-Source: APBJJlENDbF5P10ZI2S9OXCaZLaTW9QBv8KYS2TuHxgZiwNSlpwjxXOITBXHTJGCfCNVBzkk9uTeSA== X-Received: by 2002:adf:fa46:0:b0:314:3985:b291 with SMTP id y6-20020adffa46000000b003143985b291mr2269145wrr.15.1689850744408; Thu, 20 Jul 2023 03:59:04 -0700 (PDT) Received: from localhost ([137.220.119.58]) by smtp.gmail.com with ESMTPSA id w10-20020adfd4ca000000b003140f47224csm1004363wrk.15.2023.07.20.03.59.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Jul 2023 03:59:04 -0700 (PDT) From: luca.boccassi@gmail.com To: Ali Alnubani Cc: John McNamara , dpdk stable Subject: patch 'doc: fix typos and wording in flow API guide' has been queued to stable release 20.11.9 Date: Thu, 20 Jul 2023 11:58:50 +0100 Message-Id: <20230720105859.2537307-1-luca.boccassi@gmail.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230714223447.1092828-18-luca.boccassi@gmail.com> References: <20230714223447.1092828-18-luca.boccassi@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Hi, FYI, your patch has been queued to stable release 20.11.9 Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet. It will be pushed if I get no objections before 07/22/23. So please shout if anyone has objections. Also note that after the patch there's a diff of the upstream commit vs the patch applied to the branch. This will indicate if there was any rebasing needed to apply to the stable branch. If there were code changes for rebasing (ie: not only metadata diffs), please double check that the rebase was correctly done. Queued patches are on a temporary branch at: https://github.com/bluca/dpdk-stable This queued commit can be viewed at: https://github.com/bluca/dpdk-stable/commit/4a803e9647df89258556fbffad8767d3784ef718 Thanks. Luca Boccassi --- >From 4a803e9647df89258556fbffad8767d3784ef718 Mon Sep 17 00:00:00 2001 From: Ali Alnubani Date: Sun, 16 Jul 2023 09:58:26 +0300 Subject: [PATCH] doc: fix typos and wording in flow API guide [ upstream commit d9f1751090ce1055a64f1d9a5f43758acae2c5ac ] This fixes typos, punctuation and wording in the rte flow API guide. Fixes: 2f82d143fb31 ("ethdev: add group jump action") Signed-off-by: Ali Alnubani Acked-by: John McNamara --- doc/guides/prog_guide/rte_flow.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index 6ac00d424f..c5749e8257 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -117,14 +117,15 @@ 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 that +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. @@ -139,7 +140,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 @@ -1610,12 +1611,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 -- 2.39.2 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2023-07-20 11:54:24.286967027 +0100 +++ 0001-doc-fix-typos-and-wording-in-flow-API-guide.patch 2023-07-20 11:54:24.221504304 +0100 @@ -1 +1 @@ -From d9f1751090ce1055a64f1d9a5f43758acae2c5ac Mon Sep 17 00:00:00 2001 +From 4a803e9647df89258556fbffad8767d3784ef718 Mon Sep 17 00:00:00 2001 @@ -5,0 +6,2 @@ +[ upstream commit d9f1751090ce1055a64f1d9a5f43758acae2c5ac ] + @@ -9 +10,0 @@ -Cc: stable@dpdk.org @@ -18 +19 @@ -index 28d09c58d5..5bc998a433 100644 +index 6ac00d424f..c5749e8257 100644 @@ -21 +22 @@ -@@ -148,14 +148,15 @@ Attribute: Group +@@ -117,14 +117,15 @@ Attribute: Group @@ -41 +42 @@ -@@ -170,7 +171,7 @@ Priority levels are arbitrary and up to the application, they do +@@ -139,7 +140,7 @@ Priority levels are arbitrary and up to the application, they do @@ -50 +51 @@ -@@ -1769,12 +1770,12 @@ flow group/tables on the device, this action redirects the matched flow to +@@ -1610,12 +1611,12 @@ flow group/tables on the device, this action redirects the matched flow to