doc: fix octeontx2 eventdev devargs

Message ID 20200219065511.3877-1-pbhagavatula@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: fix octeontx2 eventdev devargs |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot warning Travis build: failed

Commit Message

Pavan Nikhilesh Bhagavatula Feb. 19, 2020, 6:55 a.m. UTC
  From: Pavan Nikhilesh <pbhagavatula@marvell.com>

Fix OCTEON TX2 event device devargs examples.

Fixes: 55e778ca4648 ("event/octeontx2: add devargs for inflight buffer count")
Cc: stable@dpdk.org

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
---
 doc/guides/eventdevs/octeontx2.rst | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)
  

Comments

Jerin Jacob Feb. 21, 2020, 10:13 a.m. UTC | #1
On Wed, Feb 19, 2020 at 12:25 PM <pbhagavatula@marvell.com> wrote:
>
> From: Pavan Nikhilesh <pbhagavatula@marvell.com>
>
> Fix OCTEON TX2 event device devargs examples.
>
> Fixes: 55e778ca4648 ("event/octeontx2: add devargs for inflight buffer count")
> Cc: stable@dpdk.org
>
> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>

Reviewed-by: Jerin Jacob <jerinj@marvell.com>

Thomas,
This is the only patch for RC4 from the eventdev tree.
Could you please merge this directly to dpdk.git?


> ---
>  doc/guides/eventdevs/octeontx2.rst | 18 +++++++++---------
>  1 file changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/doc/guides/eventdevs/octeontx2.rst b/doc/guides/eventdevs/octeontx2.rst
> index fad84cf42..d4b2515ce 100644
> --- a/doc/guides/eventdevs/octeontx2.rst
> +++ b/doc/guides/eventdevs/octeontx2.rst
> @@ -66,7 +66,7 @@ Runtime Config Options
>    upper limit for in-flight events.
>    For example::
>
> -    --dev "0002:0e:00.0,xae_cnt=16384"
> +    -w 0002:0e:00.0,xae_cnt=16384
>
>  - ``Force legacy mode``
>
> @@ -74,7 +74,7 @@ Runtime Config Options
>    single workslot mode in SSO and disable the default dual workslot mode.
>    For example::
>
> -    --dev "0002:0e:00.0,single_ws=1"
> +    -w 0002:0e:00.0,single_ws=1
>
>  - ``Event Group QoS support``
>
> @@ -89,7 +89,7 @@ Runtime Config Options
>    default.
>    For example::
>
> -    --dev "0002:0e:00.0,qos=[1-50-50-50]"
> +    -w 0002:0e:00.0,qos=[1-50-50-50]
>
>  - ``Selftest``
>
> @@ -98,7 +98,7 @@ Runtime Config Options
>    The tests are run once the vdev creation is successfully complete.
>    For example::
>
> -    --dev "0002:0e:00.0,selftest=1"
> +    -w 0002:0e:00.0,selftest=1
>
>  - ``TIM disable NPA``
>
> @@ -107,7 +107,7 @@ Runtime Config Options
>    parameter disables NPA and uses software mempool to manage chunks
>    For example::
>
> -    --dev "0002:0e:00.0,tim_disable_npa=1"
> +    -w 0002:0e:00.0,tim_disable_npa=1
>
>  - ``TIM modify chunk slots``
>
> @@ -118,7 +118,7 @@ Runtime Config Options
>    to SSO. The default value is 255 and the max value is 4095.
>    For example::
>
> -    --dev "0002:0e:00.0,tim_chnk_slots=1023"
> +    -w 0002:0e:00.0,tim_chnk_slots=1023
>
>  - ``TIM enable arm/cancel statistics``
>
> @@ -126,7 +126,7 @@ Runtime Config Options
>    event timer adapter.
>    For example::
>
> -    --dev "0002:0e:00.0,tim_stats_ena=1"
> +    -w 0002:0e:00.0,tim_stats_ena=1
>
>  - ``TIM limit max rings reserved``
>
> @@ -136,7 +136,7 @@ Runtime Config Options
>    rings.
>    For example::
>
> -    --dev "0002:0e:00.0,tim_rings_lmt=5"
> +    -w 0002:0e:00.0,tim_rings_lmt=5
>
>  - ``TIM ring control internal parameters``
>
> @@ -146,7 +146,7 @@ Runtime Config Options
>    default values.
>    For Example::
>
> -    --dev "0002:0e:00.0,tim_ring_ctl=[2-1023-1-0]"
> +    -w 0002:0e:00.0,tim_ring_ctl=[2-1023-1-0]
>
>  Debugging Options
>  ~~~~~~~~~~~~~~~~~
> --
> 2.17.1
>
  
Thomas Monjalon Feb. 21, 2020, 10:16 a.m. UTC | #2
21/02/2020 11:13, Jerin Jacob:
> On Wed, Feb 19, 2020 at 12:25 PM <pbhagavatula@marvell.com> wrote:
> >
> > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> >
> > Fix OCTEON TX2 event device devargs examples.
> >
> > Fixes: 55e778ca4648 ("event/octeontx2: add devargs for inflight buffer count")
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> 
> Reviewed-by: Jerin Jacob <jerinj@marvell.com>
> 
> Thomas,
> This is the only patch for RC4 from the eventdev tree.
> Could you please merge this directly to dpdk.git?

Yes, sure.
  
Thomas Monjalon Feb. 21, 2020, 5:16 p.m. UTC | #3
21/02/2020 11:13, Jerin Jacob:
> On Wed, Feb 19, 2020 at 12:25 PM <pbhagavatula@marvell.com> wrote:
> >
> > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> >
> > Fix OCTEON TX2 event device devargs examples.
> >
> > Fixes: 55e778ca4648 ("event/octeontx2: add devargs for inflight buffer count")
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> 
> Reviewed-by: Jerin Jacob <jerinj@marvell.com>

Applied, thanks
  

Patch

diff --git a/doc/guides/eventdevs/octeontx2.rst b/doc/guides/eventdevs/octeontx2.rst
index fad84cf42..d4b2515ce 100644
--- a/doc/guides/eventdevs/octeontx2.rst
+++ b/doc/guides/eventdevs/octeontx2.rst
@@ -66,7 +66,7 @@  Runtime Config Options
   upper limit for in-flight events.
   For example::
 
-    --dev "0002:0e:00.0,xae_cnt=16384"
+    -w 0002:0e:00.0,xae_cnt=16384
 
 - ``Force legacy mode``
 
@@ -74,7 +74,7 @@  Runtime Config Options
   single workslot mode in SSO and disable the default dual workslot mode.
   For example::
 
-    --dev "0002:0e:00.0,single_ws=1"
+    -w 0002:0e:00.0,single_ws=1
 
 - ``Event Group QoS support``
 
@@ -89,7 +89,7 @@  Runtime Config Options
   default.
   For example::
 
-    --dev "0002:0e:00.0,qos=[1-50-50-50]"
+    -w 0002:0e:00.0,qos=[1-50-50-50]
 
 - ``Selftest``
 
@@ -98,7 +98,7 @@  Runtime Config Options
   The tests are run once the vdev creation is successfully complete.
   For example::
 
-    --dev "0002:0e:00.0,selftest=1"
+    -w 0002:0e:00.0,selftest=1
 
 - ``TIM disable NPA``
 
@@ -107,7 +107,7 @@  Runtime Config Options
   parameter disables NPA and uses software mempool to manage chunks
   For example::
 
-    --dev "0002:0e:00.0,tim_disable_npa=1"
+    -w 0002:0e:00.0,tim_disable_npa=1
 
 - ``TIM modify chunk slots``
 
@@ -118,7 +118,7 @@  Runtime Config Options
   to SSO. The default value is 255 and the max value is 4095.
   For example::
 
-    --dev "0002:0e:00.0,tim_chnk_slots=1023"
+    -w 0002:0e:00.0,tim_chnk_slots=1023
 
 - ``TIM enable arm/cancel statistics``
 
@@ -126,7 +126,7 @@  Runtime Config Options
   event timer adapter.
   For example::
 
-    --dev "0002:0e:00.0,tim_stats_ena=1"
+    -w 0002:0e:00.0,tim_stats_ena=1
 
 - ``TIM limit max rings reserved``
 
@@ -136,7 +136,7 @@  Runtime Config Options
   rings.
   For example::
 
-    --dev "0002:0e:00.0,tim_rings_lmt=5"
+    -w 0002:0e:00.0,tim_rings_lmt=5
 
 - ``TIM ring control internal parameters``
 
@@ -146,7 +146,7 @@  Runtime Config Options
   default values.
   For Example::
 
-    --dev "0002:0e:00.0,tim_ring_ctl=[2-1023-1-0]"
+    -w 0002:0e:00.0,tim_ring_ctl=[2-1023-1-0]
 
 Debugging Options
 ~~~~~~~~~~~~~~~~~