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 54D5642EDA for ; Fri, 21 Jul 2023 15:35:26 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BA90242D2C; Fri, 21 Jul 2023 15:35:25 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 983AF40DDC for ; Fri, 21 Jul 2023 15:35:24 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689946524; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=z6XrjZV7Yeu9D0NSSvJsUIm40eMTvnCrUJFWTnm/dTk=; b=ETh4LEJPTI4YjM6vl0fR93W3fWKfc7oLd7C6RZQLK2Z3BqlcBCJL57zCH56oVd0vu/Ejmb jalT9tLehf3L5AE8HpKKm7HpUDF2ZOHhKXebsps+Y5UtZoHf7XPqM5s8n9kcfetHJaDNsl O1vO4DDRAnyDL4MVd/vMYQTtk+QYXAY= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-635-_J0lIouRNdONvMEznp4G0w-1; Fri, 21 Jul 2023 09:35:20 -0400 X-MC-Unique: _J0lIouRNdONvMEznp4G0w-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 5D0398F184D; Fri, 21 Jul 2023 13:35:20 +0000 (UTC) Received: from rh.redhat.com (unknown [10.39.192.15]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8CBC6140E949; Fri, 21 Jul 2023 13:35:19 +0000 (UTC) From: Kevin Traynor 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 21.11.5 Date: Fri, 21 Jul 2023 14:34:56 +0100 Message-ID: <20230721133509.348959-1-ktraynor@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.7 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset="US-ASCII"; x-default=true 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 21.11.5 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/25/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/kevintraynor/dpdk-stable This queued commit can be viewed at: https://github.com/kevintraynor/dpdk-stable/commit/dd28326d46529442343ce831beacd6e83640855c Thanks. Kevin --- >From dd28326d46529442343ce831beacd6e83640855c 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 61d0d0899a..91ace7ae7a 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -149,12 +149,13 @@ 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. @@ -171,5 +172,5 @@ 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. @@ -1832,10 +1833,10 @@ 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 -- 2.41.0 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2023-07-21 14:33:59.046079280 +0100 +++ 0001-doc-fix-typos-and-wording-in-flow-API-guide.patch 2023-07-21 14:33:58.986253149 +0100 @@ -1 +1 @@ -From d9f1751090ce1055a64f1d9a5f43758acae2c5ac Mon Sep 17 00:00:00 2001 +From dd28326d46529442343ce831beacd6e83640855c 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 61d0d0899a..91ace7ae7a 100644 @@ -46 +47 @@ -@@ -1770,10 +1771,10 @@ the specified group on that device. +@@ -1832,10 +1833,10 @@ the specified group on that device.