diff mbox series

[v6,5/5] doc: update doc for inflight packets clear API in vhost lib

Message ID 20210719081022.12949-6-cheng1.jiang@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Maxime Coquelin
Headers
Series vhost: handle memory hotplug for async vhost |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/github-robot success github build: passed
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-testing fail Testing issues
ci/iol-intel-Performance success Performance Testing PASS
ci/Intel-compilation warning apply issues

Commit Message

Jiang, Cheng1 July 19, 2021, 8:10 a.m. UTC 
  Update the program guide and release notes for inflight packets clear
API in vhost lib.

Signed-off-by: Cheng Jiang <cheng1.jiang@intel.com>
---
 doc/guides/prog_guide/vhost_lib.rst    | 5 +++++
 doc/guides/rel_notes/release_21_08.rst | 5 +++++
 2 files changed, 10 insertions(+)

Comments

Maxime Coquelin July 21, 2021, 2:37 p.m. UTC | #1 
On 7/19/21 10:10 AM, Cheng Jiang wrote:
> Update the program guide and release notes for inflight packets clear
> API in vhost lib.
> 
> Signed-off-by: Cheng Jiang <cheng1.jiang@intel.com>
> ---
>  doc/guides/prog_guide/vhost_lib.rst    | 5 +++++
>  doc/guides/rel_notes/release_21_08.rst | 5 +++++
>  2 files changed, 10 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst
> index d18fb98910..3cdfdc0725 100644
> --- a/doc/guides/prog_guide/vhost_lib.rst
> +++ b/doc/guides/prog_guide/vhost_lib.rst
> @@ -281,6 +281,11 @@ The following is an overview of some key Vhost API functions:
>    Poll enqueue completion status from async data path. Completed packets
>    are returned to applications through ``pkts``.
>  
> +* ``rte_vhost_clear_queue_thread_unsafe(vid, queue_id, **pkts, count)``
> +
> +  Clear inflight packets which are submitted to DMA engine in vhost async data
> +  path. Completed packets are returned to applications through ``pkts``.
> +
>  Vhost-user Implementations
>  --------------------------
>  
> diff --git a/doc/guides/rel_notes/release_21_08.rst b/doc/guides/rel_notes/release_21_08.rst
> index 6a902ef9ac..482d16ba13 100644
> --- a/doc/guides/rel_notes/release_21_08.rst
> +++ b/doc/guides/rel_notes/release_21_08.rst
> @@ -117,6 +117,11 @@ New Features
>    The experimental PMD power management API now supports managing
>    multiple Ethernet Rx queues per lcore.
>  
> +* **Added inflight packets clear API in vhost library.**
> +
> +  Added an API which can clear the inflight packets submitted to DMA
> +  engine in vhost async data path.
> +
>  
>  Removed Items
>  -------------
> 

Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst
index d18fb98910..3cdfdc0725 100644
--- a/doc/guides/prog_guide/vhost_lib.rst
+++ b/doc/guides/prog_guide/vhost_lib.rst
@@ -281,6 +281,11 @@  The following is an overview of some key Vhost API functions:
   Poll enqueue completion status from async data path. Completed packets
   are returned to applications through ``pkts``.
 
+* ``rte_vhost_clear_queue_thread_unsafe(vid, queue_id, **pkts, count)``
+
+  Clear inflight packets which are submitted to DMA engine in vhost async data
+  path. Completed packets are returned to applications through ``pkts``.
+
 Vhost-user Implementations
 --------------------------
 
diff --git a/doc/guides/rel_notes/release_21_08.rst b/doc/guides/rel_notes/release_21_08.rst
index 6a902ef9ac..482d16ba13 100644
--- a/doc/guides/rel_notes/release_21_08.rst
+++ b/doc/guides/rel_notes/release_21_08.rst
@@ -117,6 +117,11 @@  New Features
   The experimental PMD power management API now supports managing
   multiple Ethernet Rx queues per lcore.
 
+* **Added inflight packets clear API in vhost library.**
+
+  Added an API which can clear the inflight packets submitted to DMA
+  engine in vhost async data path.
+
 
 Removed Items
 -------------