Skip to contentSkip to conversation

net/mlx5: fix devlink documentation table warning

PATCH In review Randy Dunlap 2 participants 2 messages Jan 9, 2022

Subsystems (4)
lore
Share & tools
lore

Randy Dunlap

author reviewer
#0 lore raw

PATCH 1/1 net/mlx5: fix devlink documentation table warning

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")
Cc Shay Drory <[email protected]>
Cc Saeed Mahameed <[email protected]>
Cc "David S. Miller" <[email protected]>
Cc Jakub Kicinski <[email protected]>
---
 Documentation/networking/devlink/mlx5.rst |    1 +
 1 file changed, 1 insertion(+)
Documentation/networking/devlink/mlx5.rst +1 -0
@@ -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.
maintainer
#1 lore raw
Quoted 19 lines · 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")
Cc Shay Drory <[email protected]>
Cc Saeed Mahameed <[email protected]>
Cc "David S. Miller" <[email protected]>
Cc Jakub Kicinski <[email protected]>
---
 Documentation/networking/devlink/mlx5.rst |    1 +
 1 file changed, 1 insertion(+)

Documentation/networking/devlink/mlx5.rst Parameters · line 23

Quoted 7 lines
Documentation/networking/devlink/mlx5.rst +1 -0
@@ -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!