diff mbox series

net/mlx5: fix devlink documentation table warning

Message ID 20220109061845.11635-1-rdunlap@infradead.org (mailing list archive)
State Not Applicable
Delegated to: Netdev Maintainers
Headers show
Series net/mlx5: fix devlink documentation table warning | expand

Checks

Context Check Description
netdev/tree_selection success Guessing tree name failed - patch did not apply

Commit Message

Randy Dunlap Jan. 9, 2022, 6:18 a.m. UTC
Fix a table format warning in networking/devlink/mlx5 by adding
another column data entry:

Documentation/networking/devlink/mlx5.rst:13: WARNING: Error parsing content block for the "list-table" directive: uniform two-level bullet list expected, but row 2 does not contain the same number of items as row 1 (2 vs 3).

Fixes: 0844fa5f7b89 ("net/mlx5: Let user configure io_eq_size param")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Shay Drory <shayd@nvidia.com>
Cc: Saeed Mahameed <saeedm@nvidia.com>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
---
 Documentation/networking/devlink/mlx5.rst |    1 +
 1 file changed, 1 insertion(+)

Comments

Jakub Kicinski Jan. 9, 2022, 10:08 p.m. UTC | #1
On Sat,  8 Jan 2022 22:18:45 -0800 Randy Dunlap wrote:
> Fix a table format warning in networking/devlink/mlx5 by adding
> another column data entry:
> 
> Documentation/networking/devlink/mlx5.rst:13: WARNING: Error parsing content block for the "list-table" directive: uniform two-level bullet list expected, but row 2 does not contain the same number of items as row 1 (2 vs 3).
> 
> Fixes: 0844fa5f7b89 ("net/mlx5: Let user configure io_eq_size param")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Cc: Shay Drory <shayd@nvidia.com>
> Cc: Saeed Mahameed <saeedm@nvidia.com>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Jakub Kicinski <kuba@kernel.org>
> ---
>  Documentation/networking/devlink/mlx5.rst |    1 +
>  1 file changed, 1 insertion(+)
> 
> --- linux-next-20220107.orig/Documentation/networking/devlink/mlx5.rst
> +++ linux-next-20220107/Documentation/networking/devlink/mlx5.rst
> @@ -17,6 +17,7 @@ Parameters
>       - Validation
>     * - ``enable_roce``
>       - driverinit
> +     - This is a boolean value (0 or 1, false or true).
>     * - ``io_eq_size``
>       - driverinit
>       - The range is between 64 and 4096.

We got:

745a13061aa0 ("Documentation: devlink: mlx5.rst: Fix htmldoc build warning")

in net-next already. Thanks, tho!
diff mbox series

Patch

--- linux-next-20220107.orig/Documentation/networking/devlink/mlx5.rst
+++ linux-next-20220107/Documentation/networking/devlink/mlx5.rst
@@ -17,6 +17,7 @@  Parameters
      - Validation
    * - ``enable_roce``
      - driverinit
+     - This is a boolean value (0 or 1, false or true).
    * - ``io_eq_size``
      - driverinit
      - The range is between 64 and 4096.