doc: add NASM installation steps
Checks
Commit Message
The intel-ipsec-mb library requires NASM as a dependency.
Steps on how to get and install NASM are added on the documentation
of the crypto PMDs which requires the library.
Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
doc/guides/cryptodevs/aesni_gcm.rst | 14 ++++++++++++++
doc/guides/cryptodevs/aesni_mb.rst | 14 ++++++++++++++
doc/guides/cryptodevs/kasumi.rst | 14 ++++++++++++++
doc/guides/cryptodevs/snow3g.rst | 14 ++++++++++++++
doc/guides/cryptodevs/zuc.rst | 14 ++++++++++++++
5 files changed, 70 insertions(+)
Comments
On 18/05/2020 09:35, Pablo de Lara wrote:
> The intel-ipsec-mb library requires NASM as a dependency.
Hi Pablo,
Thanks for the patch. Couple of comments below.
Kevin.
> Steps on how to get and install NASM are added on the documentation
> of the crypto PMDs which requires the library.
>
Bugzilla ID: 417
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> ---
> doc/guides/cryptodevs/aesni_gcm.rst | 14 ++++++++++++++
> doc/guides/cryptodevs/aesni_mb.rst | 14 ++++++++++++++
> doc/guides/cryptodevs/kasumi.rst | 14 ++++++++++++++
> doc/guides/cryptodevs/snow3g.rst | 14 ++++++++++++++
> doc/guides/cryptodevs/zuc.rst | 14 ++++++++++++++
> 5 files changed, 70 insertions(+)
>
> diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
> index 7dfd0ca..e4b0e7e 100644
> --- a/doc/guides/cryptodevs/aesni_gcm.rst
> +++ b/doc/guides/cryptodevs/aesni_gcm.rst
> @@ -50,6 +50,20 @@ can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v0.54.zip
> make
> make install
>
> +The library requires NASM to be built. Depending on the library version, it might
> +require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
> +
> +NASM is packaged for different OS. However, on some OS the version is too old,
> +so a manual installation is required. In that case, NASM can be downloaded from
> +`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
Getting some warnings because of the 'here':
$ make doc-guides-html
sphinx processing guides-html..
/home/ktraynor/code/dpdk/doc/guides/cryptodevs/aesni_gcm.rst:5: WARNING:
Duplicate explicit target name: "here".
/home/ktraynor/code/dpdk/doc/guides/cryptodevs/aesni_mb.rst:5: WARNING:
Duplicate explicit target name: "here".
/home/ktraynor/code/dpdk/doc/guides/cryptodevs/kasumi.rst:5: WARNING:
Duplicate explicit target name: "here".
/home/ktraynor/code/dpdk/doc/guides/cryptodevs/snow3g.rst:5: WARNING:
Duplicate explicit target name: "here".
/home/ktraynor/code/dpdk/doc/guides/cryptodevs/zuc.rst:5: WARNING:
Duplicate explicit target name: "here".
> +Once it is downloaded, extract it and follow these steps:
> +
> +.. code-block:: console
> +
> + ./configure
> + make
> + make install
> +
> .. note::
>
> Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
> diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
> index a2c3a84..9154fb4 100644
> --- a/doc/guides/cryptodevs/aesni_mb.rst
> +++ b/doc/guides/cryptodevs/aesni_mb.rst
> @@ -75,6 +75,20 @@ can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.54.z
> make
> make install
>
> +The library requires NASM to be built. Depending on the library version, it might
> +require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
> +
> +NASM is packaged for different OS. However, on some OS the version is too old,
> +so a manual installation is required. In that case, NASM can be downloaded from
> +`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
> +Once it is downloaded, extract it and follow these steps:
> +
> +.. code-block:: console
> +
> + ./configure
> + make
> + make install
> +
> .. note::
>
> Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
> diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst
> index edbc1c6..4a582a7 100644
> --- a/doc/guides/cryptodevs/kasumi.rst
> +++ b/doc/guides/cryptodevs/kasumi.rst
> @@ -47,6 +47,20 @@ on their system before building DPDK:
> make
> make install
>
> +The library requires NASM to be built. Depending on the library version, it might
> +require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
> +
> +NASM is packaged for different OS. However, on some OS the version is too old,
> +so a manual installation is required. In that case, NASM can be downloaded from
> +`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
> +Once it is downloaded, extract it and follow these steps:
> +
> +.. code-block:: console
> +
> + ./configure
> + make
> + make install
> +
> .. note::
>
> Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
> diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst
> index b715b46..eedc230 100644
> --- a/doc/guides/cryptodevs/snow3g.rst
> +++ b/doc/guides/cryptodevs/snow3g.rst
> @@ -46,6 +46,20 @@ on their system before building DPDK:
> make
> make install
>
> +The library requires NASM to be built. Depending on the library version, it might
> +require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
> +
> +NASM is packaged for different OS. However, on some OS the version is too old,
> +so a manual installation is required. In that case, NASM can be downloaded from
> +`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
> +Once it is downloaded, extract it and follow these steps:
> +
> +.. code-block:: console
> +
> + ./configure
> + make
> + make install
> +
> .. note::
>
> Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
> diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst
> index c384f3d..0741e57 100644
> --- a/doc/guides/cryptodevs/zuc.rst
> +++ b/doc/guides/cryptodevs/zuc.rst
> @@ -46,6 +46,20 @@ on their system before building DPDK:
> make
> make install
>
> +The library requires NASM to be built. Depending on the library version, it might
> +require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
> +
> +NASM is packaged for different OS. However, on some OS the version is too old,
> +so a manual installation is required. In that case, NASM can be downloaded from
> +`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
> +Once it is downloaded, extract it and follow these steps:
> +
> +.. code-block:: console
> +
> + ./configure
> + make
> + make install
> +
> .. note::
>
> Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
>
Hi Kevin,
> -----Original Message-----
> From: Kevin Traynor <ktraynor@redhat.com>
> Sent: Wednesday, May 20, 2020 11:39 AM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Mcnamara, John
> <john.mcnamara@intel.com>; Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: dev@dpdk.org
> Subject: Re: [PATCH] doc: add NASM installation steps
>
> On 18/05/2020 09:35, Pablo de Lara wrote:
> > The intel-ipsec-mb library requires NASM as a dependency.
>
> Hi Pablo,
>
> Thanks for the patch. Couple of comments below.
>
> Kevin.
>
> > Steps on how to get and install NASM are added on the documentation of
> > the crypto PMDs which requires the library.
> >
>
> Bugzilla ID: 417
Thanks for the comments. Will send a v2 shortly.
Pablo
@@ -50,6 +50,20 @@ can be downloaded in `<https://github.com/01org/intel-ipsec-mb/archive/v0.54.zip
make
make install
+The library requires NASM to be built. Depending on the library version, it might
+require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
+
+NASM is packaged for different OS. However, on some OS the version is too old,
+so a manual installation is required. In that case, NASM can be downloaded from
+`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
+Once it is downloaded, extract it and follow these steps:
+
+.. code-block:: console
+
+ ./configure
+ make
+ make install
+
.. note::
Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
@@ -75,6 +75,20 @@ can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.54.z
make
make install
+The library requires NASM to be built. Depending on the library version, it might
+require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
+
+NASM is packaged for different OS. However, on some OS the version is too old,
+so a manual installation is required. In that case, NASM can be downloaded from
+`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
+Once it is downloaded, extract it and follow these steps:
+
+.. code-block:: console
+
+ ./configure
+ make
+ make install
+
.. note::
Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
@@ -47,6 +47,20 @@ on their system before building DPDK:
make
make install
+The library requires NASM to be built. Depending on the library version, it might
+require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
+
+NASM is packaged for different OS. However, on some OS the version is too old,
+so a manual installation is required. In that case, NASM can be downloaded from
+`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
+Once it is downloaded, extract it and follow these steps:
+
+.. code-block:: console
+
+ ./configure
+ make
+ make install
+
.. note::
Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
@@ -46,6 +46,20 @@ on their system before building DPDK:
make
make install
+The library requires NASM to be built. Depending on the library version, it might
+require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
+
+NASM is packaged for different OS. However, on some OS the version is too old,
+so a manual installation is required. In that case, NASM can be downloaded from
+`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
+Once it is downloaded, extract it and follow these steps:
+
+.. code-block:: console
+
+ ./configure
+ make
+ make install
+
.. note::
Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.
@@ -46,6 +46,20 @@ on their system before building DPDK:
make
make install
+The library requires NASM to be built. Depending on the library version, it might
+require a minimum NASM version (e.g. v0.54 requires at least NASM 2.14).
+
+NASM is packaged for different OS. However, on some OS the version is too old,
+so a manual installation is required. In that case, NASM can be downloaded from
+`here <https://www.nasm.us/pub/nasm/releasebuilds/?C=M;O=D>`_.
+Once it is downloaded, extract it and follow these steps:
+
+.. code-block:: console
+
+ ./configure
+ make
+ make install
+
.. note::
Compilation of the Multi-Buffer library is broken when GCC < 5.0, if library <= v0.53.