doc: add note for vhost builtin example

Message ID 20200325014054.79051-1-xuan.ding@intel.com (mailing list archive)
State Superseded, archived
Headers
Series doc: add note for vhost builtin example |

Checks

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

Commit Message

Ding, Xuan March 25, 2020, 1:40 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>
---
 doc/guides/sample_app_ug/vhost.rst | 6 ++++++
 1 file changed, 6 insertions(+)
  

Patch

diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index a71ada654..1db3ae931 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -201,3 +201,9 @@  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. "--socket-mem"
+  option need to be added when enabling "builtin-net-driver".