diff mbox series

net/mlx5: fix config name in Kconfig parameter documentation

Message ID 20230825125100.26453-1-lukas.bulwahn@gmail.com (mailing list archive)
State Awaiting Upstream
Delegated to: Netdev Maintainers
Headers show
Series net/mlx5: fix config name in Kconfig parameter documentation | expand

Checks

Context Check Description
netdev/tree_selection success Not a local patch

Commit Message

Lukas Bulwahn Aug. 25, 2023, 12:51 p.m. UTC
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(-)

Comments

Saeed Mahameed Aug. 25, 2023, 5:45 p.m. UTC | #1
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.
diff mbox series

Patch

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.