[PATCH] net/mlx5: fix config name in Kconfig parameter documentation

Lukas Bulwahn posted 1 patch 2 years, 3 months ago
.../device_drivers/ethernet/mellanox/mlx5/kconfig.rst           | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] net/mlx5: fix config name in Kconfig parameter documentation
Posted by Lukas Bulwahn 2 years, 3 months ago
Commit a12ba19269d7 ("net/mlx5: Update Kconfig parameter documentation")
adds documentation on Kconfig options for the mlx5 driver. It refers to the
config MLX5_EN_MACSEC for MACSec offloading, but the config is actually
called MLX5_MACSEC.

Fix the reference to the right config name in the documentation.

Fixes: a12ba19269d7 ("net/mlx5: Update Kconfig parameter documentation")
Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
---
Saeed, please pick this quick fix to the documentation.

 .../device_drivers/ethernet/mellanox/mlx5/kconfig.rst           | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/kconfig.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/kconfig.rst
index 0a42c3395ffa..20d3b7e87049 100644
--- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/kconfig.rst
+++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/kconfig.rst
@@ -67,7 +67,7 @@ Enabling the driver and kconfig options
 |    Enables :ref:`IPSec XFRM cryptography-offload acceleration <xfrm_device>`.
 
 
-**CONFIG_MLX5_EN_MACSEC=(y/n)**
+**CONFIG_MLX5_MACSEC=(y/n)**
 
 |    Build support for MACsec cryptography-offload acceleration in the NIC.
 
-- 
2.17.1
Re: [PATCH] net/mlx5: fix config name in Kconfig parameter documentation
Posted by Saeed Mahameed 2 years, 3 months ago
On 25 Aug 14:51, Lukas Bulwahn wrote:
>Commit a12ba19269d7 ("net/mlx5: Update Kconfig parameter documentation")
>adds documentation on Kconfig options for the mlx5 driver. It refers to the
>config MLX5_EN_MACSEC for MACSec offloading, but the config is actually
>called MLX5_MACSEC.
>
>Fix the reference to the right config name in the documentation.
>
>Fixes: a12ba19269d7 ("net/mlx5: Update Kconfig parameter documentation")
>Signed-off-by: Lukas Bulwahn <lukas.bulwahn@gmail.com>
>---
>Saeed, please pick this quick fix to the documentation.

Thanks applied to net-next-mlx5.