patch 'doc: fix typos and wording in flow API guide' has been queued to stable release 22.11.3

Xueming Li xuemingl at nvidia.com
Thu Aug 10 02:10:22 CEST 2023


Hi,

FYI, your patch has been queued to stable release 22.11.3

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 08/11/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://git.dpdk.org/dpdk-stable/log/?h=22.11-staging

This queued commit can be viewed at:
https://git.dpdk.org/dpdk-stable/commit/?h=22.11-staging&id=759c53365ac959eeb4fc9f6dd7c5effdec8de716

Thanks.

Xueming Li <xuemingl at nvidia.com>

---
>From 759c53365ac959eeb4fc9f6dd7c5effdec8de716 Mon Sep 17 00:00:00 2001
From: Ali Alnubani <alialnu at nvidia.com>
Date: Sun, 16 Jul 2023 09:58:26 +0300
Subject: [PATCH] doc: fix typos and wording in flow API guide
Cc: Xueming Li <xuemingl at nvidia.com>

[ 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 <alialnu at nvidia.com>
Acked-by: John McNamara <john.mcnamara at intel.com>
---
 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 e98f1fdd52..d0b7833a2f 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -148,14 +148,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.
@@ -170,7 +171,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
@@ -1741,12 +1742,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.25.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2023-08-09 21:51:20.860326600 +0800
+++ 0105-doc-fix-typos-and-wording-in-flow-API-guide.patch	2023-08-09 21:51:18.274352000 +0800
@@ -1 +1 @@
-From d9f1751090ce1055a64f1d9a5f43758acae2c5ac Mon Sep 17 00:00:00 2001
+From 759c53365ac959eeb4fc9f6dd7c5effdec8de716 Mon Sep 17 00:00:00 2001
@@ -4,0 +5,3 @@
+Cc: Xueming Li <xuemingl at nvidia.com>
+
+[ upstream commit d9f1751090ce1055a64f1d9a5f43758acae2c5ac ]
@@ -9 +11,0 @@
-Cc: stable at dpdk.org
@@ -18 +20 @@
-index 28d09c58d5..5bc998a433 100644
+index e98f1fdd52..d0b7833a2f 100644
@@ -50 +52 @@
-@@ -1769,12 +1770,12 @@ flow group/tables on the device, this action redirects the matched flow to
+@@ -1741,12 +1742,12 @@ flow group/tables on the device, this action redirects the matched flow to


More information about the stable mailing list