[dpdk-dev] doc: fix crypto scheduler command line examples

Message ID 20170707043656.8728-1-pablo.de.lara.guarch@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Pablo de Lara Guarch
Headers

Checks

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

Commit Message

De Lara Guarch, Pablo July 7, 2017, 4:36 a.m. UTC
  Sample command lines for crypto scheduler were not correct,
due to:
- Typo in "crypto_scheduler" driver name
- Multiple virtual devices require having unique names,
  driver name + a suffix, otherwise, just a single device is
  created.

Fixes: d58a3f312545 ("crypto/scheduler: add documentation")
CC: stable@dpdk.org

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
 doc/guides/cryptodevs/scheduler.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
  

Comments

John McNamara July 7, 2017, 12:46 p.m. UTC | #1
> -----Original Message-----
> From: De Lara Guarch, Pablo
> Sent: Friday, July 7, 2017 5:37 AM
> To: Mcnamara, John <john.mcnamara@intel.com>; Doherty, Declan
> <declan.doherty@intel.com>
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>;
> stable@dpdk.org
> Subject: [PATCH] doc: fix crypto scheduler command line examples
> 
> Sample command lines for crypto scheduler were not correct, due to:
> - Typo in "crypto_scheduler" driver name
> - Multiple virtual devices require having unique names,
>   driver name + a suffix, otherwise, just a single device is
>   created.
> 
> Fixes: d58a3f312545 ("crypto/scheduler: add documentation")
> CC: stable@dpdk.org
> 
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>


Acked-by: John McNamara <john.mcnamara@intel.com>
  
De Lara Guarch, Pablo July 11, 2017, 2:10 p.m. UTC | #2
> -----Original Message-----
> From: Mcnamara, John
> Sent: Friday, July 7, 2017 1:47 PM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Doherty,
> Declan <declan.doherty@intel.com>
> Cc: dev@dpdk.org; stable@dpdk.org
> Subject: RE: [PATCH] doc: fix crypto scheduler command line examples
> 
> 
> 
> > -----Original Message-----
> > From: De Lara Guarch, Pablo
> > Sent: Friday, July 7, 2017 5:37 AM
> > To: Mcnamara, John <john.mcnamara@intel.com>; Doherty, Declan
> > <declan.doherty@intel.com>
> > Cc: dev@dpdk.org; De Lara Guarch, Pablo
> > <pablo.de.lara.guarch@intel.com>; stable@dpdk.org
> > Subject: [PATCH] doc: fix crypto scheduler command line examples
> >
> > Sample command lines for crypto scheduler were not correct, due to:
> > - Typo in "crypto_scheduler" driver name
> > - Multiple virtual devices require having unique names,
> >   driver name + a suffix, otherwise, just a single device is
> >   created.
> >
> > Fixes: d58a3f312545 ("crypto/scheduler: add documentation")
> > CC: stable@dpdk.org
> >
> > Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> 
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied to dpdk-next-crypto.

Pablo
  

Patch

diff --git a/doc/guides/cryptodevs/scheduler.rst b/doc/guides/cryptodevs/scheduler.rst
index be2eb0b..f3ee88a 100644
--- a/doc/guides/cryptodevs/scheduler.rst
+++ b/doc/guides/cryptodevs/scheduler.rst
@@ -72,9 +72,9 @@  Initialization
 
 To use the PMD in an application, user must:
 
-* Call rte_vdev_init("crpyto_scheduler") within the application.
+* Call rte_vdev_init("crypto_scheduler") within the application.
 
-* Use --vdev="crpyto_scheduler" in the EAL options, which will call
+* Use --vdev="crypto_scheduler" in the EAL options, which will call
   rte_vdev_init() internally.
 
 
@@ -106,7 +106,7 @@  Example:
 
 .. code-block:: console
 
-    ... --vdev "crypto_aesni_mb_pmd,name=aesni_mb_1" --vdev "crypto_aesni_mb_pmd,name=aesni_mb_2" --vdev "crypto_scheduler_pmd,slave=aesni_mb_1,slave=aesni_mb_2" ...
+    ... --vdev "crypto_aesni_mb0,name=aesni_mb_1" --vdev "crypto_aesni_mb1,name=aesni_mb_2" --vdev "crypto_scheduler,slave=aesni_mb_1,slave=aesni_mb_2" ...
 
 .. note::