diff mbox series

[v1,2/7] doc: fix blank line in asynchronous operations description

Message ID 20230516063747.3047758-3-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 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.

Fixes: 197e820c6685 ("ethdev: bring in async queue-based flow rules operations")
Cc: akozyrev@nvidia.com
Cc: stable@dpdk.org

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

Comments

Ori Kam May 17, 2023, 5:13 p.m. UTC | #1 
Hi Michael,

> -----Original Message-----
> From: Michael Baum <michaelba@nvidia.com>
> Sent: Tuesday, May 16, 2023 9:38 AM
> 
> 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.
> 
> Fixes: 197e820c6685 ("ethdev: bring in async queue-based flow rules
> operations")
> Cc: akozyrev@nvidia.com
> Cc: stable@dpdk.org
> 
> Signed-off-by: Michael Baum <michaelba@nvidia.com>
> ---
>  doc/guides/prog_guide/rte_flow.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/doc/guides/prog_guide/rte_flow.rst
> b/doc/guides/prog_guide/rte_flow.rst
> index e7faa368a1..76e69190fc 100644
> --- a/doc/guides/prog_guide/rte_flow.rst
> +++ b/doc/guides/prog_guide/rte_flow.rst
> @@ -3702,6 +3702,7 @@ Asynchronous operations
>  -----------------------
> 
>  Flow rules management can be done via special lockless flow management
> queues.
> +
>  - Queue operations are asynchronous and not thread-safe.
> 
>  - Operations can thus be invoked by the app's datapath,
> --
> 2.25.1

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

Patch

diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst
index e7faa368a1..76e69190fc 100644
--- a/doc/guides/prog_guide/rte_flow.rst
+++ b/doc/guides/prog_guide/rte_flow.rst
@@ -3702,6 +3702,7 @@  Asynchronous operations
 -----------------------
 
 Flow rules management can be done via special lockless flow management queues.
+
 - Queue operations are asynchronous and not thread-safe.
 
 - Operations can thus be invoked by the app's datapath,