[v2] doc/prog_guide: fix readability in lib vhost prog guide
Checks
Commit Message
fix grammar issues and readbility in vhost library programmer guide
Fixes: 768274ebbd5e ("vhost: avoid populate guest memory")
Cc: stable@dpdk.org
Signed-off-by: Herakliusz Lipiec <herakliusz.lipiec@intel.com>
---
doc/guides/prog_guide/vhost_lib.rst | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
Comments
> -----Original Message-----
> From: Lipiec, Herakliusz <herakliusz.lipiec@intel.com>
> Sent: Thursday, June 23, 2022 9:57 PM
> To: maxime.coquelin@redhat.com; Xia, Chenbo <chenbo.xia@intel.com>
> Cc: dev@dpdk.org; Lipiec, Herakliusz <herakliusz.lipiec@intel.com>;
> stable@dpdk.org
> Subject: [PATCH v2] doc/prog_guide: fix readability in lib vhost prog
> guide
>
> fix grammar issues and readbility in vhost library programmer guide
>
> Fixes: 768274ebbd5e ("vhost: avoid populate guest memory")
> Cc: stable@dpdk.org
>
> Signed-off-by: Herakliusz Lipiec <herakliusz.lipiec@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 606edee940..4675347ee5 100644
> --- a/doc/guides/prog_guide/vhost_lib.rst
> +++ b/doc/guides/prog_guide/vhost_lib.rst
> @@ -351,7 +351,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.
> @@ -382,12 +382,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
> @@ -395,8 +395,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.36.1
Reviewed-by: Chenbo Xia <chenbo.xia@intel.com>
On 6/23/22 15:57, Herakliusz Lipiec wrote:
> fix grammar issues and readbility in vhost library programmer guide
>
> Fixes: 768274ebbd5e ("vhost: avoid populate guest memory")
> Cc: stable@dpdk.org
>
> Signed-off-by: Herakliusz Lipiec <herakliusz.lipiec@intel.com>
> ---
> doc/guides/prog_guide/vhost_lib.rst | 18 +++++++++---------
> 1 file changed, 9 insertions(+), 9 deletions(-)
>
Applied to dpdk-next-virtio/main.
Thanks,
Maxime
@@ -351,7 +351,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.
@@ -382,12 +382,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
@@ -395,8 +395,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
---------------------------------