patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Michael Baum <michaelba@nvidia.com>
To: <dev@dpdk.org>
Cc: Ori Kam <orika@nvidia.com>,
	Aman Singh <aman.deep.singh@intel.com>,
	"Yuying Zhang" <yuying.zhang@intel.com>,
	Ferruh Yigit <ferruh.yigit@amd.com>,
	 "Thomas Monjalon" <thomas@monjalon.net>, <akozyrev@nvidia.com>,
	<stable@dpdk.org>
Subject: [PATCH v2 1/5] doc: fix blank lines in modify field action description
Date: Thu, 18 May 2023 20:40:11 +0300	[thread overview]
Message-ID: <20230518174015.3373185-2-michaelba@nvidia.com> (raw)
In-Reply-To: <20230518174015.3373185-1-michaelba@nvidia.com>

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.

Fixes: 73b68f4c54a0 ("ethdev: introduce generic modify flow action")
Cc: akozyrev@nvidia.com
Cc: stable@dpdk.org

Signed-off-by: Michael Baum <michaelba@nvidia.com>
---
 doc/guides/prog_guide/rte_flow.rst | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index 32fc45516a..e7faa368a1 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -2917,20 +2917,23 @@ The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it
 ``RTE_FLOW_FIELD_START`` is used to point to the beginning of a packet.
 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.25.1


  parent reply	other threads:[~2023-05-18 17:40 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20230516063747.3047758-1-michaelba@nvidia.com>
2023-05-16  6:37 ` [PATCH v1 1/7] " Michael Baum
2023-05-16  6:37 ` [PATCH v1 2/7] doc: fix blank line in asynchronous operations description Michael Baum
2023-05-17 17:13   ` Ori Kam
2023-05-16  6:37 ` [PATCH v1 3/7] doc: fix wrong indentation in RSS action description Michael Baum
2023-05-18  6:18   ` Ori Kam
     [not found] ` <20230518174015.3373185-1-michaelba@nvidia.com>
2023-05-18 17:40   ` Michael Baum [this message]
2023-05-21 10:07     ` [PATCH v2 1/5] doc: fix blank lines in modify field " Ori Kam
2023-05-18 17:40   ` [PATCH v2 2/5] doc: fix blank line in asynchronous operations description Michael Baum
2023-05-21 10:07     ` Ori Kam
2023-05-18 17:40   ` [PATCH v2 3/5] doc: fix wrong indentation in RSS action description Michael Baum
2023-05-21 10:08     ` Ori Kam
     [not found]   ` <20230522192804.3759072-1-michaelba@nvidia.com>
2023-05-22 19:28     ` [PATCH v3 1/5] doc: fix blank lines in modify field " Michael Baum
2023-05-22 19:28     ` [PATCH v3 2/5] doc: fix blank line in asynchronous operations description Michael Baum
2023-05-22 19:28     ` [PATCH v3 3/5] doc: fix wrong indentation in RSS action description Michael Baum
     [not found]     ` <20230523124805.3846360-1-michaelba@nvidia.com>
2023-05-23 12:48       ` [PATCH v4 1/5] doc: fix blank lines in modify field " Michael Baum
2023-05-23 12:48       ` [PATCH v4 2/5] doc: fix blank line in asynchronous operations description Michael Baum
2023-05-23 12:48       ` [PATCH v4 3/5] doc: fix wrong indentation in RSS action description Michael Baum
     [not found]       ` <20230523213157.3905696-1-michaelba@nvidia.com>
2023-05-23 21:31         ` [PATCH v5 1/5] doc: fix blank lines in modify field " Michael Baum
2023-05-23 21:31         ` [PATCH v5 2/5] doc: fix blank line in asynchronous operations description Michael Baum
2023-05-23 21:31         ` [PATCH v5 3/5] doc: fix wrong indentation in RSS action description Michael Baum

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230518174015.3373185-2-michaelba@nvidia.com \
    --to=michaelba@nvidia.com \
    --cc=akozyrev@nvidia.com \
    --cc=aman.deep.singh@intel.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@amd.com \
    --cc=orika@nvidia.com \
    --cc=stable@dpdk.org \
    --cc=thomas@monjalon.net \
    --cc=yuying.zhang@intel.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).