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 D00C142ECF for ; Thu, 20 Jul 2023 17:22:08 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id CC6C842D32; Thu, 20 Jul 2023 17:22:08 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id 265C342D2C for ; Thu, 20 Jul 2023 17:22:07 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689866526; 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: in-reply-to:in-reply-to:references:references; bh=G+DUfpAIm3VUYAZC/obziKXRDlk7davFe3iqv/TrR5E=; b=Hnp5pYuU78NsrKBOo/7Gd4wtgIzY9PvDRVRlMqrrtfZwR6zxHzWwV51ZzNE0cYUpWAu7Sk jOkM1ThdhH59HuvA/rzO7Fx5jtWYy2ro4bX4xO7QRKWnbewCwgzS4+qVDiJIAXO72V4J7M foP4g4LYv7Sgf0mB9ODH8pvBuzWQdrM= 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-226-k0GZeQwPMGWEVUZOeiGPPw-1; Thu, 20 Jul 2023 11:21:26 -0400 X-MC-Unique: k0GZeQwPMGWEVUZOeiGPPw-1 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 558A41065068; Thu, 20 Jul 2023 15:20:52 +0000 (UTC) Received: from rh.redhat.com (unknown [10.39.192.15]) by smtp.corp.redhat.com (Postfix) with ESMTP id 32AAD492C13; Thu, 20 Jul 2023 15:20:51 +0000 (UTC) From: Kevin Traynor To: Michael Baum Cc: Ori Kam , dpdk stable Subject: patch 'doc: fix format in flow API guide' has been queued to stable release 21.11.5 Date: Thu, 20 Jul 2023 16:17:48 +0100 Message-ID: <20230720151942.262154-37-ktraynor@redhat.com> In-Reply-To: <20230720151942.262154-1-ktraynor@redhat.com> References: <20230720151942.262154-1-ktraynor@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 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/57a458ded6c02c49ff7fefb8682d992f903fba00 Thanks. Kevin --- >From 57a458ded6c02c49ff7fefb8682d992f903fba00 Mon Sep 17 00:00:00 2001 From: Michael Baum Date: Wed, 24 May 2023 00:31:53 +0300 Subject: [PATCH] doc: fix format in flow API guide [ upstream commit 5d254667810fffe59190ca208a078bcb666a2a71 ] The modify field action description inside "Generic flow API (rte_flow)" documentation, lists all operations supported for a destination field. In addition, it lists the values supported for a encapsulation level field. Before the lists, in both cases, miss a blank line causing them to look regular text lines. This patch adds the blank lines. The asynchronous operations description inside "Generic flow API (rte_flow)" documentation, adds some bullets to describe asynchronous operations behavior. Before the first bullet, miss a blank line causing it to look a regular text line. This patch adds the blank line. The RSS action description inside "Generic flow API (rte_flow)" documentation, lists the values supported for a encapsulation level field. For "2" value, it uses 3 spaces as an indentation instead of 2 after line breaking, causing the first line to be bold. This patch updates the number of spaces in the indentation. Fixes: 73b68f4c54a0 ("ethdev: introduce generic modify flow action") Fixes: 197e820c6685 ("ethdev: bring in async queue-based flow rules operations") Fixes: 18aee2861a1f ("ethdev: add encap level to RSS flow API action") Signed-off-by: Michael Baum Acked-by: Ori Kam --- doc/guides/prog_guide/rte_flow.rst | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index 7984e889c4..61d0d0899a 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2009,6 +2009,6 @@ Also, regarding packet encapsulation ``level``: - ``2`` and subsequent values request RSS to be performed on the specified - inner packet encapsulation level, from outermost to innermost (lower to - higher values). + inner packet encapsulation level, from outermost to innermost (lower to + higher values). Values other than ``0`` are not necessarily supported. @@ -3067,18 +3067,21 @@ The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it See ``enum rte_flow_field_id`` for the list of supported fields. -``op`` selects the operation to perform on a destination field. +``op`` selects the operation to perform on a destination field: + - ``set`` copies the data from ``src`` field to ``dst`` field. - ``add`` adds together ``dst`` and ``src`` and stores the result into ``dst``. -- ``sub`` subtracts ``src`` from ``dst`` and stores the result into ``dst`` +- ``sub`` subtracts ``src`` from ``dst`` and stores the result into ``dst``. ``width`` defines a number of bits to use from ``src`` field. ``level`` is used to access any packet field on any encapsulation level -as well as any tag element in the tag array. -- ``0`` means the default behaviour. Depending on the packet type, it can -mean outermost, innermost or anything in between. +as well as any tag element in the tag array: + +- ``0`` means the default behaviour. Depending on the packet type, + it can mean outermost, innermost or anything in between. - ``1`` requests access to the outermost packet encapsulation level. - ``2`` and subsequent values requests access to the specified packet -encapsulation level, from outermost to innermost (lower to higher values). + encapsulation level, from outermost to innermost (lower to higher values). + For the tag array (in case of multiple tags are supported and present) ``level`` translates directly into the array index. -- 2.41.0 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2023-07-20 16:17:59.536281745 +0100 +++ 0037-doc-fix-format-in-flow-API-guide.patch 2023-07-20 16:17:54.615750320 +0100 @@ -1 +1 @@ -From 5d254667810fffe59190ca208a078bcb666a2a71 Mon Sep 17 00:00:00 2001 +From 57a458ded6c02c49ff7fefb8682d992f903fba00 Mon Sep 17 00:00:00 2001 @@ -5,0 +6,2 @@ +[ upstream commit 5d254667810fffe59190ca208a078bcb666a2a71 ] + @@ -31 +32,0 @@ -Cc: stable@dpdk.org @@ -36,2 +37,2 @@ - doc/guides/prog_guide/rte_flow.rst | 20 ++++++++++++-------- - 1 file changed, 12 insertions(+), 8 deletions(-) + doc/guides/prog_guide/rte_flow.rst | 19 +++++++++++-------- + 1 file changed, 11 insertions(+), 8 deletions(-) @@ -40 +41 @@ -index 27fa3dd304..7116c9ce23 100644 +index 7984e889c4..61d0d0899a 100644 @@ -43 +44 @@ -@@ -1969,6 +1969,6 @@ Also, regarding packet encapsulation ``level``: +@@ -2009,6 +2009,6 @@ Also, regarding packet encapsulation ``level``: @@ -52 +53 @@ -@@ -3050,18 +3050,21 @@ The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it +@@ -3067,18 +3067,21 @@ The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it @@ -80,6 +80,0 @@ -@@ -3857,4 +3860,5 @@ Asynchronous operations - - Flow rules management can be done via special lockless flow management queues. -+ - - Queue operations are asynchronous and not thread-safe. -