[dpdk-dev,v2] doc: fix parameter of virtio_user for container

Message ID 1488950271-28524-1-git-send-email-wang.yong19@zte.com.cn (mailing list archive)
State Superseded, archived
Headers

Checks

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

Commit Message

Yong Wang March 8, 2017, 5:17 a.m. UTC
  Update the "Virtio_user for Container Networking" doc, add the
"--file-prefix" option to testpmd in host and container to avoid
hugepage config file conflict.

Fixes: 50665deebda0 ("doc: add guide to use virtio-user for container networking")

---
v2:
* Modify the fixline from two lines to one line.
* Remove the unnecessary "_" in "--file-prefix" option.

Signed-off-by: Yong Wang <wang.yong19@zte.com.cn>
---
 doc/guides/howto/virtio_user_for_container_networking.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
  

Comments

Yuanhan Liu March 8, 2017, 5:09 a.m. UTC | #1
On Wed, Mar 08, 2017 at 12:17:51AM -0500, Yong Wang wrote:
> Update the "Virtio_user for Container Networking" doc, add the
> "--file-prefix" option to testpmd in host and container to avoid
> hugepage config file conflict.
> 
> Fixes: 50665deebda0 ("doc: add guide to use virtio-user for container networking")
> 
> ---

The three-dashes denotes the end of the commit log. Anything below it
(including your Signed-off-by) will be discarded while apply. That said,
you should put the change log under the "---" after your SoB.

Besides, if someone gave you Acked-by, Reviewed-by or Tested-by and
you were requested to make some minor changes, you could carry the
tag for later versions. Which means, you could (and should) add both
my and John's Acked-by after your SoB for v3.

	--yliu

> v2:
> * Modify the fixline from two lines to one line.
> * Remove the unnecessary "_" in "--file-prefix" option.
> 
> Signed-off-by: Yong Wang <wang.yong19@zte.com.cn>
> ---
>  doc/guides/howto/virtio_user_for_container_networking.rst | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
  

Patch

diff --git a/doc/guides/howto/virtio_user_for_container_networking.rst b/doc/guides/howto/virtio_user_for_container_networking.rst
index dbb9319..f71d071 100644
--- a/doc/guides/howto/virtio_user_for_container_networking.rst
+++ b/doc/guides/howto/virtio_user_for_container_networking.rst
@@ -111,7 +111,8 @@  some minor changes.
     .. code-block:: console
 
         $(testpmd) -l 0-1 -n 4 --socket-mem 1024,1024 \
-            --vdev 'eth_vhost0,iface=/tmp/sock0' --no-pci -- -i
+            --vdev 'eth_vhost0,iface=/tmp/sock0' \
+            --file-prefix=host --no-pci -- -i
 
 #. Start a container instance with a virtio-user port.
 
@@ -121,7 +122,8 @@  some minor changes.
             -v /dev/hugepages:/dev/hugepages \
             dpdk-app-testpmd testpmd -l 6-7 -n 4 -m 1024 --no-pci \
             --vdev=virtio_user0,path=/var/run/usvhost \
-	    -- -i --txqflags=0xf00 --disable-hw-vlan
+            --file-prefix=container \
+            -- -i --txqflags=0xf00 --disable-hw-vlan
 
 Note: If we run all above setup on the host, it's a shm-based IPC.