[dpdk-dev] doc: New option for vhost sample

Message ID 1425349386-15840-1-git-send-email-changchun.ouyang@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

Ouyang Changchun March 3, 2015, 2:23 a.m. UTC
  Since codes for this new option(--vlan-strip) are already merged into mainline,
see: commit: e3d61d1609cb9b3ea851c7776bfbb60dcfe8844a.

So the doc need update for that.

Signed-off-by: Changchun Ouyang <changchun.ouyang@intel.com>
---
 doc/guides/sample_app_ug/vhost.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
  

Comments

De Lara Guarch, Pablo March 27, 2015, 2:13 p.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ouyang Changchun
> Sent: Tuesday, March 03, 2015 2:23 AM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: New option for vhost sample
> 
> Since codes for this new option(--vlan-strip) are already merged into
> mainline,
> see: commit: e3d61d1609cb9b3ea851c7776bfbb60dcfe8844a.
> 
> So the doc need update for that.
> 
> Signed-off-by: Changchun Ouyang <changchun.ouyang@intel.com>

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
  
Thomas Monjalon March 31, 2015, 12:55 a.m. UTC | #2
> > Since codes for this new option(--vlan-strip) are already merged into
> > mainline,
> > see: commit: e3d61d1609cb9b3ea851c7776bfbb60dcfe8844a.
> > 
> > So the doc need update for that.
> > 
> > Signed-off-by: Changchun Ouyang <changchun.ouyang@intel.com>
> 
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index 76997da..b97ca6d 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -468,6 +468,14 @@  The value is 64 by default.
 
     user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir /mnt/huge -- --zero-copy 1 --tx-desc-num [0, n]
 
+**VLAN strip.**
+The VLAN strip option enable/disable the VLAN strip on host, if disabled, the guest will receive the packets with VLAN tag.
+It is enabled by default.
+
+.. code-block:: console
+
+    user@target:~$ ./build/app/vhost-switch -c f -n 4 --huge-dir /mnt/huge -- --vlan-strip [0, 1]
+
 Running the Virtual Machine (QEMU)
 ----------------------------------