doc: update dependency requirement for some PMDs
Checks
Commit Message
This patch updates the dependency requirement information
for aesni-gcm, aesni-mb, snow3g, zuc, and kasumi PMDs. Previously
building these PMDs with Make will fail when the system is
installed inte-ipsec-mb library version 1.0 or newer.
Since Make build system is deprecated already, instead of fixing
the issue the documentation is updated to state it.
Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
---
doc/guides/cryptodevs/aesni_gcm.rst | 3 ++-
doc/guides/cryptodevs/aesni_mb.rst | 3 ++-
doc/guides/cryptodevs/kasumi.rst | 3 ++-
doc/guides/cryptodevs/snow3g.rst | 3 ++-
doc/guides/cryptodevs/zuc.rst | 3 ++-
5 files changed, 10 insertions(+), 5 deletions(-)
Comments
On Wed, 23 Jun 2021 17:20:15 +0100
Fan Zhang <roy.fan.zhang@intel.com> wrote:
> diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
> index 19f95bde8e..11b23958d5 100644
> --- a/doc/guides/cryptodevs/aesni_gcm.rst
> +++ b/doc/guides/cryptodevs/aesni_gcm.rst
> @@ -83,9 +83,10 @@ and the external crypto libraries supported by them:
> 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+ Multi-buffer library 0.52 - 1.0
> + 19.05+ Multi-buffer library 0.52 - 1.0*
> ============= ================================
>
> +\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
Make is no longer a supported build system, so why mention it in docs?
Hi Stephen,
You are right, but without this we cannot rule out the chance that the
user downloaded DPDK, reverted to any version earlier than 20.11 (where make
and meson co-existed) and use make to compile - also they happened to have
intel-ipsec-mb version 1.0 or newer installed before compiling DPDK.
With the description, at least they would know switching to meson build will fix
the problem.
Regards,
Fan
> -----Original Message-----
> From: Stephen Hemminger <stephen@networkplumber.org>
> Sent: Wednesday, June 23, 2021 5:42 PM
> To: Zhang, Roy Fan <roy.fan.zhang@intel.com>
> Cc: dev@dpdk.org; gakhil@marvell.com
> Subject: Re: [dpdk-dev] doc: update dependency requirement for some
> PMDs
>
> On Wed, 23 Jun 2021 17:20:15 +0100
> Fan Zhang <roy.fan.zhang@intel.com> wrote:
>
> > diff --git a/doc/guides/cryptodevs/aesni_gcm.rst
> b/doc/guides/cryptodevs/aesni_gcm.rst
> > index 19f95bde8e..11b23958d5 100644
> > --- a/doc/guides/cryptodevs/aesni_gcm.rst
> > +++ b/doc/guides/cryptodevs/aesni_gcm.rst
> > @@ -83,9 +83,10 @@ and the external crypto libraries supported by them:
> > 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+ Multi-buffer library 0.52 - 1.0
> > + 19.05+ Multi-buffer library 0.52 - 1.0*
> > ============= ================================
> >
> > +\* Multi-buffer library 1.0 or newer only works for Meson but not Make
> build system.
>
> Make is no longer a supported build system, so why mention it in docs?
Hi Stephen,
>
> You are right, but without this we cannot rule out the chance that the
> user downloaded DPDK, reverted to any version earlier than 20.11 (where
> make
> and meson co-existed) and use make to compile - also they happened to
> have
> intel-ipsec-mb version 1.0 or newer installed before compiling DPDK.
>
> With the description, at least they would know switching to meson build will
> fix
> the problem.
>
Do you have more comments on this patch?
> > > diff --git a/doc/guides/cryptodevs/aesni_gcm.rst
> > b/doc/guides/cryptodevs/aesni_gcm.rst
> > > index 19f95bde8e..11b23958d5 100644
> > > --- a/doc/guides/cryptodevs/aesni_gcm.rst
> > > +++ b/doc/guides/cryptodevs/aesni_gcm.rst
> > > @@ -83,9 +83,10 @@ and the external crypto libraries supported by
> them:
> > > 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+ Multi-buffer library 0.52 - 1.0
> > > + 19.05+ Multi-buffer library 0.52 - 1.0*
> > > ============= ================================
> > >
> > > +\* Multi-buffer library 1.0 or newer only works for Meson but not Make
> > build system.
> >
> > Make is no longer a supported build system, so why mention it in docs?
@@ -83,9 +83,10 @@ and the external crypto libraries supported by them:
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+ Multi-buffer library 0.52 - 1.0
+ 19.05+ Multi-buffer library 0.52 - 1.0*
============= ================================
+\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
Initialization
--------------
@@ -130,9 +130,10 @@ and the Multi-Buffer library version supported by them:
18.02 0.48
18.05 - 19.02 0.49 - 0.52
19.05 - 19.08 0.52
- 19.11+ 0.52 - 1.0
+ 19.11+ 0.52 - 1.0*
============== ============================
+\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
Initialization
--------------
@@ -78,9 +78,10 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.11 - 19.11 LibSSO KASUMI
- 20.02+ Multi-buffer library 0.53 - 1.0
+ 20.02+ Multi-buffer library 0.53 - 1.0*
============= ================================
+\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
Initialization
--------------
@@ -77,9 +77,10 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.04 - 19.11 LibSSO SNOW3G
- 20.02+ Multi-buffer library 0.53 - 1.0
+ 20.02+ Multi-buffer library 0.53 - 1.0*
============= ================================
+\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
Initialization
--------------
@@ -77,9 +77,10 @@ and the external crypto libraries supported by them:
DPDK version Crypto library version
============= ================================
16.11 - 19.11 LibSSO ZUC
- 20.02+ Multi-buffer library 0.53 - 1.0
+ 20.02+ Multi-buffer library 0.53 - 1.0*
============= ================================
+\* Multi-buffer library 1.0 or newer only works for Meson but not Make build system.
Initialization
--------------