[dpdk-dev] [PATCH 1/2] doc: fix lists of supported algorithms

[dpdk-dev] [PATCH 1/2] doc: fix lists of supported algorithms

[Andrea Grandi]

Add a missing space must before the first item of the list to display it
correctly in the User Guide.

Fixes: d61f70b4c918 ("crypto/libcrypto: add driver for OpenSSL library")
Fixes: b79e4c00af0e ("cryptodev: use AES-GCM/CCM as AEAD algorithms")

Signed-off-by: Andrea Grandi <andrea.grandi@intel.com>
---
 doc/guides/cryptodevs/openssl.rst | 3 +++
 doc/guides/cryptodevs/qat.rst     | 1 +
 2 files changed, 4 insertions(+)

diff --git a/doc/guides/cryptodevs/openssl.rst b/doc/guides/cryptodevs/openssl.rst
index 243ea36..7b455ed 100644
--- a/doc/guides/cryptodevs/openssl.rst
+++ b/doc/guides/cryptodevs/openssl.rst
@@ -44,6 +44,7 @@ Features
 OpenSSL PMD has support for:
 
 Supported cipher algorithms:
+
 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
 * ``RTE_CRYPTO_CIPHER_AES_CBC``
 * ``RTE_CRYPTO_CIPHER_AES_CTR``
@@ -51,6 +52,7 @@ Supported cipher algorithms:
 * ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI``
 
 Supported authentication algorithms:
+
 * ``RTE_CRYPTO_AUTH_AES_GMAC``
 * ``RTE_CRYPTO_AUTH_MD5``
 * ``RTE_CRYPTO_AUTH_SHA1``
@@ -66,6 +68,7 @@ Supported authentication algorithms:
 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
 
 Supported AEAD algorithms:
+
 * ``RTE_CRYPTO_AEAD_AES_GCM``
 * ``RTE_CRYPTO_AEAD_AES_CCM``
 
diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index cb17b6b..581cd2f 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -78,6 +78,7 @@ Hash algorithms:
 * ``RTE_CRYPTO_AUTH_ZUC_EIA3``
 
 Supported AEAD algorithms:
+
 * ``RTE_CRYPTO_AEAD_AES_GCM``
 
 
-- 
2.8.4

[dpdk-dev] [PATCH 2/2] doc: fix format in OpenSSL installation guide

[Andrea Grandi]

List of supported OpenSSL versions and code block with dependencies were
not properly formatted.

Fixes: d61f70b4c918 ("crypto/libcrypto: add driver for OpenSSL library")

Signed-off-by: Andrea Grandi <andrea.grandi@intel.com>
---
 doc/guides/cryptodevs/openssl.rst | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/doc/guides/cryptodevs/openssl.rst b/doc/guides/cryptodevs/openssl.rst
index 7b455ed..61a4da3 100644
--- a/doc/guides/cryptodevs/openssl.rst
+++ b/doc/guides/cryptodevs/openssl.rst
@@ -80,17 +80,23 @@ To compile openssl PMD, it has to be enabled in the config/common_base file
 and appropriate openssl packages have to be installed in the build environment.
 
 The newest openssl library version is supported:
+
 * 1.0.2h-fips  3 May 2016.
+
 Older versions that were also verified:
+
 * 1.0.1f 6 Jan 2014
 * 1.0.1 14 Mar 2012
 
 For Ubuntu 14.04 LTS these packages have to be installed in the build system:
-sudo apt-get install openssl
-sudo apt-get install libc6-dev-i386 (for i686-native-linuxapp-gcc target)
+
+.. code-block:: console
+
+    sudo apt-get install openssl
+    sudo apt-get install libc6-dev-i386 # for i686-native-linuxapp-gcc target
 
 This code was also verified on Fedora 24.
-This code was NOT yet verified on FreeBSD.
+This code has NOT been verified on FreeBSD yet.
 
 Initialization
 --------------
-- 
2.8.4

Re: [dpdk-dev] [PATCH 1/2] doc: fix lists of supported algorithms

[De Lara Guarch, Pablo]

Hi Andrea,

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Andrea Grandi
> Sent: Wednesday, November 22, 2017 6:03 PM
> To: dev@dpdk.org
> Cc: stable@dpdk.org
> Subject: [dpdk-dev] [PATCH 1/2] doc: fix lists of supported algorithms
> 
> Add a missing space must before the first item of the list to display it
> correctly in the User Guide.
> 
> Fixes: d61f70b4c918 ("crypto/libcrypto: add driver for OpenSSL library")
> Fixes: b79e4c00af0e ("cryptodev: use AES-GCM/CCM as AEAD algorithms")
> 
> Signed-off-by: Andrea Grandi <andrea.grandi@intel.com>

For next time, add CC: stable@dpdk.org under the Fixes line.

Thanks,

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Re: [dpdk-dev] [PATCH 2/2] doc: fix format in OpenSSL installation guide

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Andrea Grandi
> Sent: Wednesday, November 22, 2017 6:03 PM
> To: dev@dpdk.org
> Cc: stable@dpdk.org
> Subject: [dpdk-dev] [PATCH 2/2] doc: fix format in OpenSSL installation
> guide
> 
> List of supported OpenSSL versions and code block with dependencies were
> not properly formatted.
> 
> Fixes: d61f70b4c918 ("crypto/libcrypto: add driver for OpenSSL library")
> 
> Signed-off-by: Andrea Grandi <andrea.grandi@intel.com>

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Re: [dpdk-dev] [PATCH 1/2] doc: fix lists of supported algorithms

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Andrea Grandi
> Sent: Wednesday, November 22, 2017 6:03 PM
> To: dev@dpdk.org
> Cc: stable@dpdk.org
> Subject: [dpdk-dev] [PATCH 1/2] doc: fix lists of supported algorithms
> 
> Add a missing space must before the first item of the list to display it
> correctly in the User Guide.
> 
> Fixes: d61f70b4c918 ("crypto/libcrypto: add driver for OpenSSL library")
> Fixes: b79e4c00af0e ("cryptodev: use AES-GCM/CCM as AEAD algorithms")
> 
> Signed-off-by: Andrea Grandi <andrea.grandi@intel.com>

Series applied to dpdk-next-crypto.
Thanks,

Pablo