[3/6] doc: update the description for in-order Rx path

Message ID 20190813020730.10038-4-tiwei.bie@intel.com
State Accepted
Delegated to: Maxime Coquelin
Headers show
Series
  • Some updates for virtio guide
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Tiwei Bie Aug. 13, 2019, 2:07 a.m.
The virtio_recv_mergeable_pkts_inorder() has been renamed to
virtio_recv_pkts_inorder() and added the non-mergeable support
in below commit.

Fixes: efcda13648d2 ("net/virtio: add non-mergeable support to in-order path")
Cc: stable@dpdk.org

Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
---
 doc/guides/nics/virtio.rst | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

Comments

Maxime Coquelin Sept. 6, 2019, 1:18 p.m. | #1
On 8/13/19 4:07 AM, Tiwei Bie wrote:
> The virtio_recv_mergeable_pkts_inorder() has been renamed to
> virtio_recv_pkts_inorder() and added the non-mergeable support
> in below commit.
> 
> Fixes: efcda13648d2 ("net/virtio: add non-mergeable support to in-order path")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
> ---
>  doc/guides/nics/virtio.rst | 7 +++----
>  1 file changed, 3 insertions(+), 4 deletions(-)

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

Patch

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 08438d064..b3c356856 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -215,8 +215,8 @@  Rx callbacks:
    Vector version without mergeable Rx buffer support, also fixes the available
    ring indexes and uses vector instructions to optimize performance.
 
-#. ``virtio_recv_mergeable_pkts_inorder``:
-   In-order version with mergeable Rx buffer support.
+#. ``virtio_recv_pkts_inorder``:
+   In-order version with mergeable and non-mergeable Rx buffer support.
 
 Tx callbacks:
 
@@ -250,8 +250,7 @@  Example of using the vector version of the virtio poll mode driver in
 
 In-order callbacks only work on simulated virtio user vdev.
 
-*   For Rx: If mergeable Rx buffers is enabled and in-order is enabled then
-    ``virtio_recv_mergeable_pkts_inorder`` is used.
+*   For Rx: If in-order is enabled then ``virtio_recv_pkts_inorder`` is used.
 
 *   For Tx: If in-order is enabled then ``virtio_xmit_pkts_inorder`` is used.