RE: [PATCH] net/mlx5: docs: correct section reference in table of contents

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 




> From: Lukas Bulwahn <lukas.bulwahn@xxxxxxxxx>
> Sent: Friday, February 5, 2021 3:25 PM
> 
> Commit 142d93d12dc1 ("net/mlx5: Add devlink subfunction port
> documentation") refers to a section 'mlx5 port function' in the table of
> contents, but includes a section 'mlx5 function attributes' instead.
> 
> Hence, make htmldocs warns:
> 
>   mlx5.rst:16: WARNING: Unknown target name: "mlx5 port function".
> 
> Correct the section reference in table of contents to the actual name of
> section in the documentation.
> 
> Also, tune another section underline while visiting this document.
> 
> Signed-off-by: Lukas Bulwahn <lukas.bulwahn@xxxxxxxxx>
> ---
> Saeed, please pick this patch for your -next tree on top of the commit above.
> 
>  .../networking/device_drivers/ethernet/mellanox/mlx5.rst      | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git
> a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5.rst
> b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5.rst
> index a1b32fcd0d76..1b7e32d8a61b 100644
> --- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5.rst
> +++
> b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5.rst
> @@ -13,12 +13,12 @@ Contents
>  - `Devlink info`_
>  - `Devlink parameters`_
>  - `mlx5 subfunction`_
> -- `mlx5 port function`_
> +- `mlx5 function attributes`_
>  - `Devlink health reporters`_
>  - `mlx5 tracepoints`_
> 
>  Enabling the driver and kconfig options -
> ================================================
> +=======================================
> 
>  | mlx5 core is modular and most of the major mlx5 core driver features can
> be selected (compiled in/out)  | at build time via kernel Kconfig flags.
> --
> 2.17.1

Thanks.
Reviewed-by: Parav Pandit <parav@xxxxxxxxxx>




[Index of Archives]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Photo]     [Yosemite News]     [Yosemite Photos]     [Linux Kernel]     [Linux SCSI]     [XFree86]

  Powered by Linux