[v2] doc: add note for vhost builtin example
diff mbox series

Message ID 20200325042115.84685-1-xuan.ding@intel.com
State Accepted, archived
Delegated to: Maxime Coquelin
Headers show
Series
  • [v2] doc: add note for vhost builtin example
Related show

Checks

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

Commit Message

Ding, Xuan March 25, 2020, 4:21 a.m. UTC
Add memory pre-allocation note for vhost example when enabling
"builtin-net-driver".

Signed-off-by: Xuan Ding <xuan.ding@intel.com>
---

v2:
* Modified expression in doc to make it more accurate.
---
 doc/guides/sample_app_ug/vhost.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Maxime Coquelin April 15, 2020, 11:10 a.m. UTC | #1
On 3/25/20 5:21 AM, Xuan Ding wrote:
> Add memory pre-allocation note for vhost example when enabling
> "builtin-net-driver".
> 
> Signed-off-by: Xuan Ding <xuan.ding@intel.com>
> ---
> 
> v2:
> * Modified expression in doc to make it more accurate.
> ---
>  doc/guides/sample_app_ug/vhost.rst | 7 +++++++
>  1 file changed, 7 insertions(+)

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

Thanks,
Maxime
Maxime Coquelin April 17, 2020, 5:13 p.m. UTC | #2
On 3/25/20 5:21 AM, Xuan Ding wrote:
> Add memory pre-allocation note for vhost example when enabling
> "builtin-net-driver".
> 
> Signed-off-by: Xuan Ding <xuan.ding@intel.com>
> ---
> 
> v2:
> * Modified expression in doc to make it more accurate.
> ---
>  doc/guides/sample_app_ug/vhost.rst | 7 +++++++
>  1 file changed, 7 insertions(+)

Applied to dpdk-next-virtio/master

Thanks,
Maxime

Patch
diff mbox series

diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index a71ada654..b7ed4f8bd 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -201,3 +201,10 @@  Common Issues
 
   QEMU vhost net device start will fail if protocol feature is not negotiated.
   DPDK virtio-user pmd can be the replacement of QEMU.
+
+* Device start fails when enabling "builtin-net-driver" without memory
+  pre-allocation
+
+  The builtin example doesn't support dynamic memory allocation. When vhost
+  backend enables "builtin-net-driver", "--socket-mem" option should be
+  added at virtio-user pmd side as a startup item.