diff mbox

[dpdk-dev,v3,2/2] doc: Update for new HW vlan command

Message ID 1425629406-1838-3-git-send-email-changchun.ouyang@intel.com (mailing list archive)
State Accepted, archived
Headers show

Commit Message

Ouyang Changchun March 6, 2015, 8:10 a.m. UTC
Update the testpmd doc as there are new HW VLAN commands/options.

Signed-off-by: Changchun Ouyang <changchun.ouyang@intel.com>
---
 doc/guides/testpmd_app_ug/run_app.rst       | 12 +++++++++++
 doc/guides/testpmd_app_ug/testpmd_funcs.rst | 33 +++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+)

Comments

Michael Qiu March 6, 2015, 8:25 a.m. UTC | #1
On 3/6/2015 4:10 PM, Ouyang Changchun wrote:
> Update the testpmd doc as there are new HW VLAN commands/options.
>
> Signed-off-by: Changchun Ouyang <changchun.ouyang@intel.com>
> ---

Acked-by: Michael Qiu <michael.qiu@intel.com>

>  doc/guides/testpmd_app_ug/run_app.rst       | 12 +++++++++++
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 33 +++++++++++++++++++++++++++++
>  2 files changed, 45 insertions(+)
>
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
> index 67f62d2..3898e67 100644
> --- a/doc/guides/testpmd_app_ug/run_app.rst
> +++ b/doc/guides/testpmd_app_ug/run_app.rst
> @@ -262,6 +262,18 @@ They must be separated from the EAL options, shown in the previous section, with
>  
>      Disable hardware VLAN.
>  
> +*   --disable-hw-vlan-filter
> +
> +    Disable hardware VLAN filter.
> +
> +*   --disable-hw-vlan-strip
> +
> +    Disable hardware VLAN strip.
> +
> +*   --disable-hw-vlan-extend
> +
> +    Disable hardware VLAN extend.
> +
>  *   --enable-drop-en
>  
>      Enable per-queue packet drop for packets with no descriptors.
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index 218835a..b644626 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -896,6 +896,39 @@ Hardware VLAN is on by default.
>  
>  The off option is equivalent to the --disable-hw-vlan command-line option.
>  
> +port config - VLAN filter
> +~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Set hardware VLAN filter on or off for all ports:
> +
> +port config all hw-vlan-filter (on|off)
> +
> +Hardware VLAN filter is on by default.
> +
> +The off option is equivalent to the --disable-hw-vlan-filter command-line option.
> +
> +port config - VLAN strip
> +~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Set hardware VLAN strip on or off for all ports:
> +
> +port config all hw-vlan-strip (on|off)
> +
> +Hardware VLAN strip is on by default.
> +
> +The off option is equivalent to the --disable-hw-vlan-strip command-line option.
> +
> +port config - VLAN extend
> +~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Set hardware VLAN extend on or off for all ports:
> +
> +port config all hw-vlan-extend (on|off)
> +
> +Hardware VLAN extend is off by default.
> +
> +The off option is equivalent to the --disable-hw-vlan-extend command-line option.
> +
>  port config - Drop Packets
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~
>
Siobhan Butler March 8, 2015, 5:52 p.m. UTC | #2
> -----Original Message-----
> From: Ouyang, Changchun
> Sent: Friday, March 6, 2015 8:10 AM
> To: dev@dpdk.org
> Cc: Butler, Siobhan A; De Lara Guarch, Pablo; Cao, Waterman; Ouyang,
> Changchun
> Subject: [PATCH v3 2/2] doc: Update for new HW vlan command
> 
> Update the testpmd doc as there are new HW VLAN commands/options.
> 
> Signed-off-by: Changchun Ouyang <changchun.ouyang@intel.com>
> ---
>  doc/guides/testpmd_app_ug/run_app.rst       | 12 +++++++++++
>  doc/guides/testpmd_app_ug/testpmd_funcs.rst | 33
> +++++++++++++++++++++++++++++
>  2 files changed, 45 insertions(+)
> 
> diff --git a/doc/guides/testpmd_app_ug/run_app.rst
> b/doc/guides/testpmd_app_ug/run_app.rst
> index 67f62d2..3898e67 100644
> --- a/doc/guides/testpmd_app_ug/run_app.rst
> +++ b/doc/guides/testpmd_app_ug/run_app.rst
> @@ -262,6 +262,18 @@ They must be separated from the EAL options,
> shown in the previous section, with
> 
>      Disable hardware VLAN.
> 
> +*   --disable-hw-vlan-filter
> +
> +    Disable hardware VLAN filter.
> +
> +*   --disable-hw-vlan-strip
> +
> +    Disable hardware VLAN strip.
> +
> +*   --disable-hw-vlan-extend
> +
> +    Disable hardware VLAN extend.
> +
>  *   --enable-drop-en
> 
>      Enable per-queue packet drop for packets with no descriptors.
> diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> index 218835a..b644626 100644
> --- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> +++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
> @@ -896,6 +896,39 @@ Hardware VLAN is on by default.
> 
>  The off option is equivalent to the --disable-hw-vlan command-line option.
> 
> +port config - VLAN filter
> +~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Set hardware VLAN filter on or off for all ports:
> +
> +port config all hw-vlan-filter (on|off)
> +
> +Hardware VLAN filter is on by default.
> +
> +The off option is equivalent to the --disable-hw-vlan-filter command-line
> option.
> +
> +port config - VLAN strip
> +~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Set hardware VLAN strip on or off for all ports:
> +
> +port config all hw-vlan-strip (on|off)
> +
> +Hardware VLAN strip is on by default.
> +
> +The off option is equivalent to the --disable-hw-vlan-strip command-line
> option.
> +
> +port config - VLAN extend
> +~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Set hardware VLAN extend on or off for all ports:
> +
> +port config all hw-vlan-extend (on|off)
> +
> +Hardware VLAN extend is off by default.
> +
> +The off option is equivalent to the --disable-hw-vlan-extend command-line
> option.
> +
>  port config - Drop Packets
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> --
> 1.8.4.2

Acked-by Siobhan Butler <siobhan.a.butler@intel.com>
diff mbox

Patch

diff --git a/doc/guides/testpmd_app_ug/run_app.rst b/doc/guides/testpmd_app_ug/run_app.rst
index 67f62d2..3898e67 100644
--- a/doc/guides/testpmd_app_ug/run_app.rst
+++ b/doc/guides/testpmd_app_ug/run_app.rst
@@ -262,6 +262,18 @@  They must be separated from the EAL options, shown in the previous section, with
 
     Disable hardware VLAN.
 
+*   --disable-hw-vlan-filter
+
+    Disable hardware VLAN filter.
+
+*   --disable-hw-vlan-strip
+
+    Disable hardware VLAN strip.
+
+*   --disable-hw-vlan-extend
+
+    Disable hardware VLAN extend.
+
 *   --enable-drop-en
 
     Enable per-queue packet drop for packets with no descriptors.
diff --git a/doc/guides/testpmd_app_ug/testpmd_funcs.rst b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
index 218835a..b644626 100644
--- a/doc/guides/testpmd_app_ug/testpmd_funcs.rst
+++ b/doc/guides/testpmd_app_ug/testpmd_funcs.rst
@@ -896,6 +896,39 @@  Hardware VLAN is on by default.
 
 The off option is equivalent to the --disable-hw-vlan command-line option.
 
+port config - VLAN filter
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set hardware VLAN filter on or off for all ports:
+
+port config all hw-vlan-filter (on|off)
+
+Hardware VLAN filter is on by default.
+
+The off option is equivalent to the --disable-hw-vlan-filter command-line option.
+
+port config - VLAN strip
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set hardware VLAN strip on or off for all ports:
+
+port config all hw-vlan-strip (on|off)
+
+Hardware VLAN strip is on by default.
+
+The off option is equivalent to the --disable-hw-vlan-strip command-line option.
+
+port config - VLAN extend
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set hardware VLAN extend on or off for all ports:
+
+port config all hw-vlan-extend (on|off)
+
+Hardware VLAN extend is off by default.
+
+The off option is equivalent to the --disable-hw-vlan-extend command-line option.
+
 port config - Drop Packets
 ~~~~~~~~~~~~~~~~~~~~~~~~~~