All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] net/mlx5: docs: correct section reference in table of contents
@ 2021-02-05  9:55 ` Lukas Bulwahn
  0 siblings, 0 replies; 6+ messages in thread
From: Lukas Bulwahn @ 2021-02-05  9:55 UTC (permalink / raw)
  To: Parav Pandit, Saeed Mahameed, netdev, linux-rdma
  Cc: Leon Romanovsky, Jonathan Corbet, Mauro Carvalho Chehab,
	linux-doc, kernel-janitors, linux-kernel, Lukas Bulwahn

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@gmail.com>
---
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


^ permalink raw reply related	[flat|nested] 6+ messages in thread
* [PATCH] net/mlx5: docs: correct section reference in table of contents
@ 2021-02-05  9:55 ` Lukas Bulwahn
  0 siblings, 0 replies; 6+ messages in thread
From: Lukas Bulwahn @ 2021-02-05  9:55 UTC (permalink / raw)
  To: Parav Pandit, Saeed Mahameed, netdev, linux-rdma
  Cc: Leon Romanovsky, Jonathan Corbet, Mauro Carvalho Chehab,
	linux-doc, kernel-janitors, linux-kernel, Lukas Bulwahn

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@gmail.com>
---
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

^ permalink raw reply related	[flat|nested] 6+ messages in thread
* RE: [PATCH] net/mlx5: docs: correct section reference in table of contents
  2021-02-05  9:55 ` Lukas Bulwahn
@ 2021-02-05 12:04   ` Parav Pandit
  -1 siblings, 0 replies; 6+ messages in thread
From: Parav Pandit @ 2021-02-05 12:04 UTC (permalink / raw)
  To: Lukas Bulwahn, Saeed Mahameed, netdev, linux-rdma
  Cc: Leon Romanovsky, Jonathan Corbet, Mauro Carvalho Chehab,
	linux-doc, kernel-janitors, linux-kernel



> From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> 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@gmail.com>
> ---
> 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@nvidia.com>

^ permalink raw reply	[flat|nested] 6+ messages in thread
* RE: [PATCH] net/mlx5: docs: correct section reference in table of contents
@ 2021-02-05 12:04   ` Parav Pandit
  0 siblings, 0 replies; 6+ messages in thread
From: Parav Pandit @ 2021-02-05 12:04 UTC (permalink / raw)
  To: Lukas Bulwahn, Saeed Mahameed, netdev, linux-rdma
  Cc: Leon Romanovsky, Jonathan Corbet, Mauro Carvalho Chehab,
	linux-doc, kernel-janitors, linux-kernel



> From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
> 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@gmail.com>
> ---
> 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@nvidia.com>

^ permalink raw reply	[flat|nested] 6+ messages in thread
* Re: [PATCH] net/mlx5: docs: correct section reference in table of contents
  2021-02-05  9:55 ` Lukas Bulwahn
@ 2021-02-10  5:42   ` Saeed Mahameed
  -1 siblings, 0 replies; 6+ messages in thread
From: Saeed Mahameed @ 2021-02-10  5:42 UTC (permalink / raw)
  To: Lukas Bulwahn, Parav Pandit, netdev, linux-rdma
  Cc: Leon Romanovsky, Jonathan Corbet, Mauro Carvalho Chehab,
	linux-doc, kernel-janitors, linux-kernel

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 <lukas.bulwahn@gmail.com>
> ---
> Saeed, please pick this patch for your -next tree on top of the
> commit above.

Applied to net-next-mlx5,

Thanks,
Saeed.


^ permalink raw reply	[flat|nested] 6+ messages in thread
* Re: [PATCH] net/mlx5: docs: correct section reference in table of contents
@ 2021-02-10  5:42   ` Saeed Mahameed
  0 siblings, 0 replies; 6+ messages in thread
From: Saeed Mahameed @ 2021-02-10  5:42 UTC (permalink / raw)
  To: Lukas Bulwahn, Parav Pandit, netdev, linux-rdma
  Cc: Leon Romanovsky, Jonathan Corbet, Mauro Carvalho Chehab,
	linux-doc, kernel-janitors, linux-kernel

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 <lukas.bulwahn@gmail.com>
> ---
> Saeed, please pick this patch for your -next tree on top of the
> commit above.

Applied to net-next-mlx5,

Thanks,
Saeed.

^ permalink raw reply	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-02-10  5:43 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-02-05  9:55 [PATCH] net/mlx5: docs: correct section reference in table of contents Lukas Bulwahn
2021-02-05  9:55 ` Lukas Bulwahn
2021-02-05 12:04 ` Parav Pandit
2021-02-05 12:04   ` Parav Pandit
2021-02-10  5:42 ` Saeed Mahameed
2021-02-10  5:42   ` Saeed Mahameed

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.