[v1,3/7] doc: fix wrong indentation in RSS action description

Message ID 20230516063747.3047758-4-michaelba@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Ferruh Yigit
Headers
Series ethdev: modify field API for multiple headers |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Michael Baum May 16, 2023, 6:37 a.m. UTC
  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: 18aee2861a1f ("ethdev: add encap level to RSS flow API action")
Cc: adrien.mazarguil@6wind.com
Cc: stable@dpdk.org

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

Comments

Ori Kam May 18, 2023, 6:18 a.m. UTC | #1
Hi Michael,

> -----Original Message-----
> From: Michael Baum <michaelba@nvidia.com>
> Sent: Tuesday, May 16, 2023 9:38 AM
> 
> 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: 18aee2861a1f ("ethdev: add encap level to RSS flow API action")
> Cc: adrien.mazarguil@6wind.com
> Cc: stable@dpdk.org
> 
> Signed-off-by: Michael Baum <michaelba@nvidia.com>
> ---
>  doc/guides/prog_guide/rte_flow.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/prog_guide/rte_flow.rst
> b/doc/guides/prog_guide/rte_flow.rst
> index 76e69190fc..25b57bf86d 100644
> --- a/doc/guides/prog_guide/rte_flow.rst
> +++ b/doc/guides/prog_guide/rte_flow.rst
> @@ -1954,8 +1954,8 @@ Also, regarding packet encapsulation ``level``:
>    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.
> 
> --
> 2.25.1

Acked-by: Ori Kam <orika@nvidia.com>
Best,
Ori
  

Patch

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index 76e69190fc..25b57bf86d 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -1954,8 +1954,8 @@  Also, regarding packet encapsulation ``level``:
   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.