[dpdk-dev,v2] doc: update application minimum requirement info

Message ID 1517851927-20984-1-git-send-email-vipin.varghese@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

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

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---

V2 changes:
 - updated the title from 'info on multi crypto instances' - Pablo
 - reframed affirmative word 'should' to 'shall' - pablo
---
 doc/guides/sample_app_ug/l2_forward_crypto.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
  

Comments

John McNamara Feb. 6, 2018, noon UTC | #1
> -----Original Message-----
> From: Varghese, Vipin
> Sent: Monday, February 5, 2018 5:32 PM
> To: dev@dpdk.org; Kovacevic, Marko <marko.kovacevic@intel.com>; De Lara
> Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: [PATCH v2] doc: update application minimum requirement info
> 
> Added note section to update information for use cases working with
> multiple crypto devices.
> 


Acked-by: John McNamara <john.mcnamara@intel.com>
  
De Lara Guarch, Pablo Feb. 6, 2018, 4:35 p.m. UTC | #2
> -----Original Message-----
> From: Varghese, Vipin
> Sent: Monday, February 5, 2018 5:32 PM
> To: dev@dpdk.org; Kovacevic, Marko <marko.kovacevic@intel.com>; De
> Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: [PATCH v2] doc: update application minimum requirement info
> 
> Added note section to update information for use cases working with
> multiple crypto devices.
> 
> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
  
Thomas Monjalon Feb. 6, 2018, 9:28 p.m. UTC | #3
> > Added note section to update information for use cases working with
> > multiple crypto devices.
> > 
> > Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> 
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Applied, thanks
  

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..fddfd1b 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 shall use the same session.
+
 Explanation
 -----------