2021-02-05 09:59:34

by Lukas Bulwahn

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

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 <[email protected]>
---
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

2021-02-05 12:10:41

by Parav Pandit

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

> From: Lukas Bulwahn <[email protected]>
> 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 <[email protected]>
> ---
> 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 <[email protected]>

2021-02-10 08:35:33

by Saeed Mahameed

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

On Fri, 2021-02-05 at 10:55 +0100, Lukas Bulwahn wrote:
> 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 <[email protected]>
> ---
> Saeed, please pick this patch for your -next tree on top of the
> commit above.

Applied to net-next-mlx5,

Thanks,
Saeed.