[dpdk-dev] doc: update info on multi crypto instances

Message ID 1517841347-9340-1-git-send-email-vipin.varghese@intel.com
State Superseded, archived
Delegated to: Thomas Monjalon
Headers show

Checks

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

Commit Message

Vipin Varghese Feb. 5, 2018, 2:35 p.m.
Added note section to update information for use cases working with
multiple crypto devices.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---
 doc/guides/sample_app_ug/l2_forward_crypto.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

De Lara Guarch, Pablo Feb. 5, 2018, 3:58 p.m. | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Vipin Varghese
> Sent: Monday, February 5, 2018 2:36 PM
> To: dev@dpdk.org; Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: update info on multi crypto instances
> 
> Added note section to update information for use cases working with
> multiple crypto devices.

I would change the title to something more generic, since you are adding
other info and not just the multi crypto device issue.

> 
> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> ---
>  doc/guides/sample_app_ug/l2_forward_crypto.rst | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/doc/guides/sample_app_ug/l2_forward_crypto.rst
> b/doc/guides/sample_app_ug/l2_forward_crypto.rst
> index 1e85b4a..c2e6128 100644
> --- a/doc/guides/sample_app_ug/l2_forward_crypto.rst
> +++ b/doc/guides/sample_app_ug/l2_forward_crypto.rst
> @@ -199,6 +199,14 @@ To run the application in linuxapp environment
> with 2 lcores, 2 ports and 2 cryp  Refer to the *DPDK Getting Started
> Guide* for general information on running applications  and the
> Environment Abstraction Layer (EAL) options.
> 
> +.. Note::
> +
> +    * The ``l2fwd-crypto`` sample application requires IPv4 packets for
> crypto operation.
> +
> +    * If multiple Ethernet ports is passed, then equal number of crypto
> devices are to be passed.
> +
> +    * All crypto devices should use the same session.

I would change "should" for "shall" or "will", since the app only supports one session.

> +
>  Explanation
>  -----------
> 
> --
> 1.9.1

Thanks,
Pablo
Mcnamara, John Feb. 6, 2018, 12:04 p.m. | #2
> -----Original Message-----
> From: De Lara Guarch, Pablo
> Sent: Monday, February 5, 2018 3:58 PM
> To: Varghese, Vipin <vipin.varghese@intel.com>; dev@dpdk.org; Kovacevic,
> Marko <marko.kovacevic@intel.com>
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: RE: [dpdk-dev] [PATCH] doc: update info on multi crypto instances
> 
> 
> 
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Vipin Varghese
> > Sent: Monday, February 5, 2018 2:36 PM
> > To: dev@dpdk.org; Kovacevic, Marko <marko.kovacevic@intel.com>
> > Cc: Mcnamara, John <john.mcnamara@intel.com>; Varghese, Vipin
> > <vipin.varghese@intel.com>
> > Subject: [dpdk-dev] [PATCH] doc: update info on multi crypto instances
> >
> > Added note section to update information for use cases working with
> > multiple crypto devices.
> 
> I would change the title to something more generic, since you are adding
> other info and not just the multi crypto device issue.
> 
> >
> > Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> > ---
> >  doc/guides/sample_app_ug/l2_forward_crypto.rst | 8 ++++++++
> >  1 file changed, 8 insertions(+)
> >
> > diff --git a/doc/guides/sample_app_ug/l2_forward_crypto.rst
> > b/doc/guides/sample_app_ug/l2_forward_crypto.rst
> > index 1e85b4a..c2e6128 100644
> > --- a/doc/guides/sample_app_ug/l2_forward_crypto.rst
> > +++ b/doc/guides/sample_app_ug/l2_forward_crypto.rst
> > @@ -199,6 +199,14 @@ To run the application in linuxapp environment
> > with 2 lcores, 2 ports and 2 cryp  Refer to the *DPDK Getting Started
> > Guide* for general information on running applications  and the
> > Environment Abstraction Layer (EAL) options.
> >
> > +.. Note::
> > +
> > +    * The ``l2fwd-crypto`` sample application requires IPv4 packets
> > + for
> > crypto operation.
> > +
> > +    * If multiple Ethernet ports is passed, then equal number of
> > +      crypto devices are to be passed.

Probably better as:

   If multiple Ethernet ports are passed then an equal number of
   crypto devices must be passed.

Patch

diff --git a/doc/guides/sample_app_ug/l2_forward_crypto.rst b/doc/guides/sample_app_ug/l2_forward_crypto.rst
index 1e85b4a..c2e6128 100644
--- a/doc/guides/sample_app_ug/l2_forward_crypto.rst
+++ b/doc/guides/sample_app_ug/l2_forward_crypto.rst
@@ -199,6 +199,14 @@  To run the application in linuxapp environment with 2 lcores, 2 ports and 2 cryp
 Refer to the *DPDK Getting Started Guide* for general information on running applications
 and the Environment Abstraction Layer (EAL) options.
 
+.. Note::
+
+    * The ``l2fwd-crypto`` sample application requires IPv4 packets for crypto operation.
+
+    * If multiple Ethernet ports is passed, then equal number of crypto devices are to be passed.
+
+    * All crypto devices should use the same session.
+
 Explanation
 -----------