diff mbox series

doc: fix mlx5 dependencies

Message ID 20180723114930.22543-1-adrien.mazarguil@6wind.com (mailing list archive)
State Accepted, archived
Delegated to: Shahaf Shuler
Headers show
Series doc: fix mlx5 dependencies | expand

Checks

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

Commit Message

Adrien Mazarguil July 23, 2018, 11:50 a.m. UTC
The new dependency of mlx5 to libmnl must be reflected in documentation.

Fixes: 4d5cce06231a ("net/mlx5: lay groundwork for switch offloads")

Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
---
 doc/guides/nics/mlx5.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

Comments

Yongseok Koh July 23, 2018, 10:43 p.m. UTC | #1
> On Jul 23, 2018, at 4:50 AM, Adrien Mazarguil <adrien.mazarguil@6wind.com> wrote:
> 
> The new dependency of mlx5 to libmnl must be reflected in documentation.
> 
> Fixes: 4d5cce06231a ("net/mlx5: lay groundwork for switch offloads")
> 
> Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> ---
Acked-by: Yongseok Koh <yskoh@mellanox.com>
 
Thanks
Shahaf Shuler July 24, 2018, 1:46 p.m. UTC | #2
Monday, July 23, 2018 2:51 PM, Adrien Mazarguil:
> Subject: [PATCH] doc: fix mlx5 dependencies
> 
> The new dependency of mlx5 to libmnl must be reflected in documentation.
> 
> Fixes: 4d5cce06231a ("net/mlx5: lay groundwork for switch offloads")
> 
> Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
> ---
>  doc/guides/nics/mlx5.rst | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
> 
> diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index
> ebf233649..4d692fa81 100644
> --- a/doc/guides/nics/mlx5.rst
> +++ b/doc/guides/nics/mlx5.rst
> @@ -448,6 +448,12 @@ DPDK and must be installed separately:
>    This library basically implements send/receive calls to the hardware
>    queues.
> 
> +- **libmnl**
> +
> +  Minimalistic Netlink library mainly relied on to manage E-Switch flow
> + rules (i.e. those with the "transfer" attribute and typically
> + involving  port representors).
> +
>  - **Kernel modules**
> 
>    They provide the kernel-side Verbs API and low level device drivers that
> @@ -526,6 +532,19 @@ required from that distribution.
>     this DPDK release was developed and tested against is strongly
>     recommended. Please check the `prerequisites`_.
> 
> +Libmnl
> +^^^^^^
> +
> +Minimal version for libmnl is **1.0.3**.
> +
> +As a dependency of the **iproute2** suite, this library is often
> +installed by default. It is otherwise readily available through
> +standard system packages.
> +
> +Its development headers must be installed in order to compile this PMD.
> +These packages are usually named **libmnl-dev** or **libmnl-devel**
> +depending on the Linux distribution.
> +

Applied to next-net-mlx, thanks.

>  Supported NICs
>  --------------
> 
> --
> 2.11.0
diff mbox series

Patch

diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index ebf233649..4d692fa81 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -448,6 +448,12 @@  DPDK and must be installed separately:
   This library basically implements send/receive calls to the hardware
   queues.
 
+- **libmnl**
+
+  Minimalistic Netlink library mainly relied on to manage E-Switch flow
+  rules (i.e. those with the "transfer" attribute and typically involving
+  port representors).
+
 - **Kernel modules**
 
   They provide the kernel-side Verbs API and low level device drivers that
@@ -526,6 +532,19 @@  required from that distribution.
    this DPDK release was developed and tested against is strongly
    recommended. Please check the `prerequisites`_.
 
+Libmnl
+^^^^^^
+
+Minimal version for libmnl is **1.0.3**.
+
+As a dependency of the **iproute2** suite, this library is often installed
+by default. It is otherwise readily available through standard system
+packages.
+
+Its development headers must be installed in order to compile this PMD.
+These packages are usually named **libmnl-dev** or **libmnl-devel**
+depending on the Linux distribution.
+
 Supported NICs
 --------------