[v4,2/2] doc: remove outdated version details
Checks
Commit Message
SW PMDs documentation is updated to remove details of unsupported IPsec
Multi-buffer versions.DPDK older than 20.11 is end of life. So, older
DPDK versions are removed from the Crypto library version table.
Signed-off-by: Sivaramakrishnan Venkat <venkatx.sivaramakrishnan@intel.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
v3:
- added second patch for outdated documentation updates.
---
doc/guides/cryptodevs/aesni_gcm.rst | 19 +++---------------
doc/guides/cryptodevs/aesni_mb.rst | 22 +++------------------
doc/guides/cryptodevs/chacha20_poly1305.rst | 12 ++---------
doc/guides/cryptodevs/kasumi.rst | 14 +++----------
doc/guides/cryptodevs/snow3g.rst | 15 +++-----------
doc/guides/cryptodevs/zuc.rst | 15 +++-----------
6 files changed, 17 insertions(+), 80 deletions(-)
Comments
> Subject: [PATCH v4 2/2] doc: remove outdated version details
>
> SW PMDs documentation is updated to remove details of unsupported IPsec
> Multi-buffer versions.DPDK older than 20.11 is end of life. So, older DPDK
> versions are removed from the Crypto library version table.
>
> Signed-off-by: Sivaramakrishnan Venkat
> <venkatx.sivaramakrishnan@intel.com>
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Acked-by: Wathsala Vithanage <wathsala.vithanage@arm.com>
> ---
> v3:
> - added second patch for outdated documentation updates.
> ---
> doc/guides/cryptodevs/aesni_gcm.rst | 19 +++---------------
> doc/guides/cryptodevs/aesni_mb.rst | 22 +++------------------
> doc/guides/cryptodevs/chacha20_poly1305.rst | 12 ++---------
> doc/guides/cryptodevs/kasumi.rst | 14 +++----------
> doc/guides/cryptodevs/snow3g.rst | 15 +++-----------
> doc/guides/cryptodevs/zuc.rst | 15 +++-----------
> 6 files changed, 17 insertions(+), 80 deletions(-)
>
> diff --git a/doc/guides/cryptodevs/aesni_gcm.rst
> b/doc/guides/cryptodevs/aesni_gcm.rst
> index dc665e536c..e38a03b78f 100644
> --- a/doc/guides/cryptodevs/aesni_gcm.rst
> +++ b/doc/guides/cryptodevs/aesni_gcm.rst
> @@ -62,12 +62,6 @@ Once it is downloaded, extract it and follow these
> steps:
> make
> make install
>
> -.. note::
> -
> - Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library
> <= v0.53.
> - If a lower GCC version than 5.0, the workaround proposed by the following
> link
> - should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
> -
>
> As a reference, the following table shows a mapping between the past DPDK
> versions and the external crypto libraries supported by them:
> @@ -79,18 +73,11 @@ and the external crypto libraries supported by them:
> ============= ================================
> DPDK version Crypto library version
> ============= ================================
> - 16.04 - 16.11 Multi-buffer library 0.43 - 0.44
> - 17.02 - 17.05 ISA-L Crypto v2.18
> - 17.08 - 18.02 Multi-buffer library 0.46 - 0.48
> - 18.05 - 19.02 Multi-buffer library 0.49 - 0.52
> - 19.05 - 20.08 Multi-buffer library 0.52 - 0.55
> - 20.11 - 21.08 Multi-buffer library 0.53 - 1.3*
> - 21.11 - 23.11 Multi-buffer library 1.0 - 1.5*
> - 24.03+ Multi-buffer library 1.4 - 1.5*
> + 20.11 - 21.08 Multi-buffer library 0.53 - 1.3
> + 21.11 - 23.11 Multi-buffer library 1.0 - 1.5
> + 24.03+ Multi-buffer library 1.4 - 1.5
> ============= ================================
>
> -\* Multi-buffer library 1.0 or newer only works for Meson but not Make build
> system.
> -
> Initialization
> --------------
>
> diff --git a/doc/guides/cryptodevs/aesni_mb.rst
> b/doc/guides/cryptodevs/aesni_mb.rst
> index 5d670ee237..bd7c8de07f 100644
> --- a/doc/guides/cryptodevs/aesni_mb.rst
> +++ b/doc/guides/cryptodevs/aesni_mb.rst
> @@ -121,12 +121,6 @@ Once it is downloaded, extract it and follow these
> steps:
> make
> make install
>
> -.. note::
> -
> - Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library
> <= v0.53.
> - If a lower GCC version than 5.0, the workaround proposed by the following
> link
> - should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
> -
> As a reference, the following table shows a mapping between the past DPDK
> versions and the Multi-Buffer library version supported by them:
>
> @@ -137,21 +131,11 @@ and the Multi-Buffer library version supported by
> them:
> ============== ============================
> DPDK version Multi-buffer library version
> ============== ============================
> - 2.2 - 16.11 0.43 - 0.44
> - 17.02 0.44
> - 17.05 - 17.08 0.45 - 0.48
> - 17.11 0.47 - 0.48
> - 18.02 0.48
> - 18.05 - 19.02 0.49 - 0.52
> - 19.05 - 19.08 0.52
> - 19.11 - 20.08 0.52 - 0.55
> - 20.11 - 21.08 0.53 - 1.3*
> - 21.11 - 23.11 1.0 - 1.5*
> - 24.03+ 1.4 - 1.5*
> + 20.11 - 21.08 0.53 - 1.3
> + 21.11 - 23.11 1.0 - 1.5
> + 24.03+ 1.4 - 1.5
> ============== ============================
>
> -\* Multi-buffer library 1.0 or newer only works for Meson but not Make build
> system.
> -
> Initialization
> --------------
>
> diff --git a/doc/guides/cryptodevs/chacha20_poly1305.rst
> b/doc/guides/cryptodevs/chacha20_poly1305.rst
> index c32866b301..8e0ee4f835 100644
> --- a/doc/guides/cryptodevs/chacha20_poly1305.rst
> +++ b/doc/guides/cryptodevs/chacha20_poly1305.rst
> @@ -56,12 +56,6 @@ Once it is downloaded, extract it and follow these
> steps:
> make
> make install
>
> -.. note::
> -
> - Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library
> <= v0.53.
> - If a lower GCC version than 5.0, the workaround proposed by the following
> link
> - should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
> -
> As a reference, the following table shows a mapping between the past DPDK
> versions and the external crypto libraries supported by them:
>
> @@ -72,12 +66,10 @@ and the external crypto libraries supported by them:
> ============= ================================
> DPDK version Crypto library version
> ============= ================================
> - 21.11 - 23.11 Multi-buffer library 1.0-1.5*
> - 24.03+ Multi-buffer library 1.4-1.5*
> + 21.11 - 23.11 Multi-buffer library 1.0-1.5
> + 24.03+ Multi-buffer library 1.4-1.5
> ============= ================================
>
> -\* Multi-buffer library 1.0 or newer only works for Meson but not Make build
> system.
> -
> Initialization
> --------------
>
> diff --git a/doc/guides/cryptodevs/kasumi.rst
> b/doc/guides/cryptodevs/kasumi.rst
> index a8f4e6b204..28ac452524 100644
> --- a/doc/guides/cryptodevs/kasumi.rst
> +++ b/doc/guides/cryptodevs/kasumi.rst
> @@ -69,12 +69,6 @@ Once it is downloaded, extract it and follow these
> steps:
> make
> make install
>
> -.. note::
> -
> - Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library
> <= v0.53.
> - If a lower GCC version than 5.0, the workaround proposed by the following
> link
> - should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
> -
> As a reference, the following table shows a mapping between the past DPDK
> versions and the external crypto libraries supported by them:
>
> @@ -86,13 +80,11 @@ and the external crypto libraries supported by them:
> DPDK version Crypto library version
> ============= ================================
> 16.11 - 19.11 LibSSO KASUMI
> - 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
> - 21.11 - 23.11 Multi-buffer library 1.0 - 1.5*
> - 24.03+ Multi-buffer library 1.4 - 1.5*
> + 20.11 - 21.08 Multi-buffer library 0.53 - 1.3
> + 21.11 - 23.11 Multi-buffer library 1.0 - 1.5
> + 24.03+ Multi-buffer library 1.4 - 1.5
> ============= ================================
>
> -\* Multi-buffer library 1.0 or newer only works for Meson but not Make build
> system.
> -
> Initialization
> --------------
>
> diff --git a/doc/guides/cryptodevs/snow3g.rst
> b/doc/guides/cryptodevs/snow3g.rst
> index 46863462e5..0141f62976 100644
> --- a/doc/guides/cryptodevs/snow3g.rst
> +++ b/doc/guides/cryptodevs/snow3g.rst
> @@ -78,12 +78,6 @@ Once it is downloaded, extract it and follow these
> steps:
> make
> make install
>
> -.. note::
> -
> - Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library
> <= v0.53.
> - If a lower GCC version than 5.0, the workaround proposed by the following
> link
> - should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
> -
> As a reference, the following table shows a mapping between the past DPDK
> versions and the external crypto libraries supported by them:
>
> @@ -94,14 +88,11 @@ and the external crypto libraries supported by them:
> ============= ================================
> DPDK version Crypto library version
> ============= ================================
> - 16.04 - 19.11 LibSSO SNOW3G
> - 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
> - 21.11 - 23.11 Multi-buffer library 1.0 - 1.5*
> - 24.03+ Multi-buffer library 1.4 - 1.5*
> + 20.11 - 21.08 Multi-buffer library 0.53 - 1.3
> + 21.11 - 23.11 Multi-buffer library 1.0 - 1.5
> + 24.03+ Multi-buffer library 1.4 - 1.5
> ============= ================================
>
> -\* Multi-buffer library 1.0 or newer only works for Meson but not Make build
> system.
> -
> Initialization
> --------------
>
> diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
> index 51867e1a16..97c14c8c77 100644
> --- a/doc/guides/cryptodevs/zuc.rst
> +++ b/doc/guides/cryptodevs/zuc.rst
> @@ -77,12 +77,6 @@ Once it is downloaded, extract it and follow these
> steps:
> make
> make install
>
> -.. note::
> -
> - Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library
> <= v0.53.
> - If a lower GCC version than 5.0, the workaround proposed by the following
> link
> - should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
> -
> As a reference, the following table shows a mapping between the past DPDK
> versions and the external crypto libraries supported by them:
>
> @@ -93,14 +87,11 @@ and the external crypto libraries supported by them:
> ============= ================================
> DPDK version Crypto library version
> ============= ================================
> - 16.11 - 19.11 LibSSO ZUC
> - 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
> - 21.11 - 23.11 Multi-buffer library 1.0 - 1.5*
> - 24.03+ Multi-buffer library 1.4 - 1.5*
> + 20.11 - 21.08 Multi-buffer library 0.53 - 1.3
> + 21.11 - 23.11 Multi-buffer library 1.0 - 1.5
> + 24.03+ Multi-buffer library 1.4 - 1.5
> ============= ================================
>
> -\* Multi-buffer library 1.0 or newer only works for Meson but not Make build
> system.
> -
> Initialization
> --------------
>
> --
> 2.25.1
@@ -62,12 +62,6 @@ Once it is downloaded, extract it and follow these steps:
make
make install
-.. note::
-
- Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
- If a lower GCC version than 5.0, the workaround proposed by the following link
- should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
-
As a reference, the following table shows a mapping between the past DPDK versions
and the external crypto libraries supported by them:
@@ -79,18 +73,11 @@ and the external crypto libraries supported by them:
============= ================================
DPDK version Crypto library version
============= ================================
- 16.04 - 16.11 Multi-buffer library 0.43 - 0.44
- 17.02 - 17.05 ISA-L Crypto v2.18
- 17.08 - 18.02 Multi-buffer library 0.46 - 0.48
- 18.05 - 19.02 Multi-buffer library 0.49 - 0.52
- 19.05 - 20.08 Multi-buffer library 0.52 - 0.55
- 20.11 - 21.08 Multi-buffer library 0.53 - 1.3*
- 21.11 - 23.11 Multi-buffer library 1.0 - 1.5*
- 24.03+ Multi-buffer library 1.4 - 1.5*
+ 20.11 - 21.08 Multi-buffer library 0.53 - 1.3
+ 21.11 - 23.11 Multi-buffer library 1.0 - 1.5
+ 24.03+ Multi-buffer library 1.4 - 1.5
============= ================================
-\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
-
Initialization
--------------
@@ -121,12 +121,6 @@ Once it is downloaded, extract it and follow these steps:
make
make install
-.. note::
-
- Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
- If a lower GCC version than 5.0, the workaround proposed by the following link
- should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
-
As a reference, the following table shows a mapping between the past DPDK versions
and the Multi-Buffer library version supported by them:
@@ -137,21 +131,11 @@ and the Multi-Buffer library version supported by them:
============== ============================
DPDK version Multi-buffer library version
============== ============================
- 2.2 - 16.11 0.43 - 0.44
- 17.02 0.44
- 17.05 - 17.08 0.45 - 0.48
- 17.11 0.47 - 0.48
- 18.02 0.48
- 18.05 - 19.02 0.49 - 0.52
- 19.05 - 19.08 0.52
- 19.11 - 20.08 0.52 - 0.55
- 20.11 - 21.08 0.53 - 1.3*
- 21.11 - 23.11 1.0 - 1.5*
- 24.03+ 1.4 - 1.5*
+ 20.11 - 21.08 0.53 - 1.3
+ 21.11 - 23.11 1.0 - 1.5
+ 24.03+ 1.4 - 1.5
============== ============================
-\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
-
Initialization
--------------
@@ -56,12 +56,6 @@ Once it is downloaded, extract it and follow these steps:
make
make install
-.. note::
-
- Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
- If a lower GCC version than 5.0, the workaround proposed by the following link
- should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
-
As a reference, the following table shows a mapping between the past DPDK versions
and the external crypto libraries supported by them:
@@ -72,12 +66,10 @@ and the external crypto libraries supported by them:
============= ================================
DPDK version Crypto library version
============= ================================
- 21.11 - 23.11 Multi-buffer library 1.0-1.5*
- 24.03+ Multi-buffer library 1.4-1.5*
+ 21.11 - 23.11 Multi-buffer library 1.0-1.5
+ 24.03+ Multi-buffer library 1.4-1.5
============= ================================
-\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
-
Initialization
--------------
@@ -69,12 +69,6 @@ Once it is downloaded, extract it and follow these steps:
make
make install
-.. note::
-
- Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
- If a lower GCC version than 5.0, the workaround proposed by the following link
- should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
-
As a reference, the following table shows a mapping between the past DPDK versions
and the external crypto libraries supported by them:
@@ -86,13 +80,11 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.11 - 19.11 LibSSO KASUMI
- 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
- 21.11 - 23.11 Multi-buffer library 1.0 - 1.5*
- 24.03+ Multi-buffer library 1.4 - 1.5*
+ 20.11 - 21.08 Multi-buffer library 0.53 - 1.3
+ 21.11 - 23.11 Multi-buffer library 1.0 - 1.5
+ 24.03+ Multi-buffer library 1.4 - 1.5
============= ================================
-\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
-
Initialization
--------------
@@ -78,12 +78,6 @@ Once it is downloaded, extract it and follow these steps:
make
make install
-.. note::
-
- Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
- If a lower GCC version than 5.0, the workaround proposed by the following link
- should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
-
As a reference, the following table shows a mapping between the past DPDK versions
and the external crypto libraries supported by them:
@@ -94,14 +88,11 @@ and the external crypto libraries supported by them:
============= ================================
DPDK version Crypto library version
============= ================================
- 16.04 - 19.11 LibSSO SNOW3G
- 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
- 21.11 - 23.11 Multi-buffer library 1.0 - 1.5*
- 24.03+ Multi-buffer library 1.4 - 1.5*
+ 20.11 - 21.08 Multi-buffer library 0.53 - 1.3
+ 21.11 - 23.11 Multi-buffer library 1.0 - 1.5
+ 24.03+ Multi-buffer library 1.4 - 1.5
============= ================================
-\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
-
Initialization
--------------
@@ -77,12 +77,6 @@ Once it is downloaded, extract it and follow these steps:
make
make install
-.. note::
-
- Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
- If a lower GCC version than 5.0, the workaround proposed by the following link
- should be used: `<https://github.com/intel/intel-ipsec-mb/issues/40>`_.
-
As a reference, the following table shows a mapping between the past DPDK versions
and the external crypto libraries supported by them:
@@ -93,14 +87,11 @@ and the external crypto libraries supported by them:
============= ================================
DPDK version Crypto library version
============= ================================
- 16.11 - 19.11 LibSSO ZUC
- 20.02 - 21.08 Multi-buffer library 0.53 - 1.3*
- 21.11 - 23.11 Multi-buffer library 1.0 - 1.5*
- 24.03+ Multi-buffer library 1.4 - 1.5*
+ 20.11 - 21.08 Multi-buffer library 0.53 - 1.3
+ 21.11 - 23.11 Multi-buffer library 1.0 - 1.5
+ 24.03+ Multi-buffer library 1.4 - 1.5
============= ================================
-\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
-
Initialization
--------------