patch 'doc: fix readability in vhost guide' has been queued to stable release 20.11.6

[Xueming Li]

Hi,

FYI, your patch has been queued to stable release 20.11.6

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 07/22/22. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Queued patches are on a temporary branch at:
https://github.com/steevenlee/dpdk

This queued commit can be viewed at:
https://github.com/steevenlee/dpdk/commit/a31510afb79db12b14732b3327ed7c9b345ea54e

Thanks.

Xueming Li <xuemingl at nvidia.com>

---
>From a31510afb79db12b14732b3327ed7c9b345ea54e Mon Sep 17 00:00:00 2001
From: Herakliusz Lipiec <herakliusz.lipiec at intel.com>
Date: Thu, 23 Jun 2022 14:57:21 +0100
Subject: [PATCH] doc: fix readability in vhost guide
Cc: Xueming Li <xuemingl at nvidia.com>

[ upstream commit c8a3ee49c94d72d03e2de5814bca01f7fd7d79d1 ]

fix grammar issues and readbility in vhost library programmer guide

Fixes: 768274ebbd5e ("vhost: avoid populate guest memory")

Signed-off-by: Herakliusz Lipiec <herakliusz.lipiec at intel.com>
Reviewed-by: Chenbo Xia <chenbo.xia at intel.com>
---
 doc/guides/prog_guide/vhost_lib.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/doc/guides/prog_guide/vhost_lib.rst b/doc/guides/prog_guide/vhost_lib.rst
index 493818bcf9..8970db8e5c 100644
--- a/doc/guides/prog_guide/vhost_lib.rst
+++ b/doc/guides/prog_guide/vhost_lib.rst
@@ -299,7 +299,7 @@ vhost-user implementation has two options:
 
      * The vhost supported features must be exactly the same before and
        after the restart. For example, if TSO is disabled and then enabled,
-       nothing will work and issues undefined might happen.
+       nothing will work and undefined issues might happen.
 
 No matter which mode is used, once a connection is established, DPDK
 vhost-user will start receiving and processing vhost messages from QEMU.
@@ -330,12 +330,12 @@ Guest memory requirement
 
 * Memory pre-allocation
 
-  For non-async data path, guest memory pre-allocation is not a
-  must. This can help save of memory. If users really want the guest memory
-  to be pre-allocated (e.g., for performance reason), we can add option
-  ``-mem-prealloc`` when starting QEMU. Or, we can lock all memory at vhost
-  side which will force memory to be allocated when mmap at vhost side;
-  option --mlockall in ovs-dpdk is an example in hand.
+  For non-async data path guest memory pre-allocation is not a
+  must but can help save memory. To do this we can add option
+  ``-mem-prealloc`` when starting QEMU, or we can lock all memory at vhost
+  side which will force memory to be allocated when it calls mmap
+  (option --mlockall in ovs-dpdk is an example in hand).
+
 
   For async data path, we force the VM memory to be pre-allocated at vhost
   lib when mapping the guest memory; and also we need to lock the memory to
@@ -343,8 +343,8 @@ Guest memory requirement
 
 * Memory sharing
 
-  Make sure ``share=on`` QEMU option is given. vhost-user will not work with
-  a QEMU version without shared memory mapping.
+  Make sure ``share=on`` QEMU option is given. The vhost-user will not work with
+  a QEMU instance without shared memory mapping.
 
 Vhost supported vSwitch reference
 ---------------------------------
-- 
2.35.1

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2022-07-20 15:01:01.430983845 +0800
+++ 0057-doc-fix-readability-in-vhost-guide.patch	2022-07-20 15:00:58.801000350 +0800
@@ -1 +1 @@
-From c8a3ee49c94d72d03e2de5814bca01f7fd7d79d1 Mon Sep 17 00:00:00 2001
+From a31510afb79db12b14732b3327ed7c9b345ea54e Mon Sep 17 00:00:00 2001
@@ -4,0 +5,3 @@
+Cc: Xueming Li <xuemingl at nvidia.com>
+
+[ upstream commit c8a3ee49c94d72d03e2de5814bca01f7fd7d79d1 ]
@@ -9 +11,0 @@
-Cc: stable at dpdk.org
@@ -18 +20 @@
-index a4ffed9fa1..bad4d819e1 100644
+index 493818bcf9..8970db8e5c 100644
@@ -21 +23 @@
-@@ -351,7 +351,7 @@ vhost-user implementation has two options:
+@@ -299,7 +299,7 @@ vhost-user implementation has two options:
@@ -30 +32 @@
-@@ -382,12 +382,12 @@ Guest memory requirement
+@@ -330,12 +330,12 @@ Guest memory requirement
@@ -49 +51 @@
-@@ -395,8 +395,8 @@ Guest memory requirement
+@@ -343,8 +343,8 @@ Guest memory requirement