Here is fixes for mlx5 devlink info documentation. The first fixes
htmldocs warnings on the mainline, while the rest is formatting fixes.
Bagas Sanjaya (4):
Documentation: net/mlx5: Wrap vnic reporter devlink commands in code
blocks
Documentation: net/mlx5: Use bullet and definition lists for vnic
counters description
Documentation: net/mlx5: Add blank line separator before numbered
lists
Documentation: net/mlx5: Wrap notes in admonition blocks
.../ethernet/mellanox/mlx5/devlink.rst | 60 ++++++++++++-------
1 file changed, 37 insertions(+), 23 deletions(-)
base-commit: c6d96df9fa2c1d19525239d4262889cce594ce6c
--
An old man doll... just what I always wanted! - Clara
Sphinx reports htmldocs warnings:
Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst:287: WARNING: Unexpected indentation.
Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst:288: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst:290: WARNING: Unexpected indentation.
Fix above warnings by wrapping diagnostic devlink commands in "vnic
reporter" section in code blocks to be consistent with other devlink
command snippets.
Fixes: b0bc615df488ab ("net/mlx5: Add vnic devlink health reporter to PFs/VFs")
Fixes: cf14af140a5ad0 ("net/mlx5e: Add vnic devlink health reporter to representors")
Signed-off-by: Bagas Sanjaya <[email protected]>
---
.../device_drivers/ethernet/mellanox/mlx5/devlink.rst | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst
index 3a7a714cc08f0a..0f0598caea145f 100644
--- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst
+++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst
@@ -283,10 +283,14 @@ nic_receive_steering_discard: number of packets that completed RX flow
steering but were discarded due to a mismatch in flow table.
User commands examples:
-- Diagnose PF/VF vnic counters
+
+- Diagnose PF/VF vnic counters::
+
$ devlink health diagnose pci/0000:82:00.1 reporter vnic
+
- Diagnose representor vnic counters (performed by supplying devlink port of the
- representor, which can be obtained via devlink port command)
+ representor, which can be obtained via devlink port command)::
+
$ devlink health diagnose pci/0000:82:00.1/65537 reporter vnic
NOTE: This command can run over all interfaces such as PF/VF and representor ports.
--
An old man doll... just what I always wanted! - Clara
The doc forgets to add separator before numbered lists, which causes the
lists to be appended to previous paragraph inline instead.
Add the missing separator.
Fixes: f2d51e579359b7 ("net/mlx5: Separate mlx5 driver documentation into multiple pages")
Signed-off-by: Bagas Sanjaya <[email protected]>
---
.../device_drivers/ethernet/mellanox/mlx5/devlink.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst
index 00687425d8b72d..f962c0975d8428 100644
--- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst
+++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst
@@ -40,6 +40,7 @@ flow_steering_mode: Device flow steering mode
---------------------------------------------
The flow steering mode parameter controls the flow steering mode of the driver.
Two modes are supported:
+
1. 'dmfs' - Device managed flow steering.
2. 'smfs' - Software/Driver managed flow steering.
@@ -99,6 +100,7 @@ between representors and stacked devices.
By default metadata is enabled on the supported devices in E-switch.
Metadata is applicable only for E-switch in switchdev mode and
users may disable it when NONE of the below use cases will be in use:
+
1. HCA is in Dual/multi-port RoCE mode.
2. VF/SF representor bonding (Usually used for Live migration)
3. Stacked devices
--
An old man doll... just what I always wanted! - Clara
Wrap note paragraphs in note:: directive as it better fit for the
purpose of noting devlink commands.
Fixes: f2d51e579359b7 ("net/mlx5: Separate mlx5 driver documentation into multiple pages")
Fixes: cf14af140a5ad0 ("net/mlx5e: Add vnic devlink health reporter to representors")
Signed-off-by: Bagas Sanjaya <[email protected]>
---
.../ethernet/mellanox/mlx5/devlink.rst | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst
index f962c0975d8428..3354ca3608ee67 100644
--- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst
+++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst
@@ -182,7 +182,8 @@ User commands examples:
$ devlink health diagnose pci/0000:82:00.0 reporter tx
-NOTE: This command has valid output only when interface is up, otherwise the command has empty output.
+.. note::
+ This command has valid output only when interface is up, otherwise the command has empty output.
- Show number of tx errors indicated, number of recover flows ended successfully,
is autorecover enabled and graceful period from last recover::
@@ -234,8 +235,9 @@ User commands examples:
$ devlink health dump show pci/0000:82:00.0 reporter fw
-NOTE: This command can run only on the PF which has fw tracer ownership,
-running it on other PF or any VF will return "Operation not permitted".
+.. note::
+ This command can run only on the PF which has fw tracer ownership,
+ running it on other PF or any VF will return "Operation not permitted".
fw fatal reporter
-----------------
@@ -258,7 +260,8 @@ User commands examples:
$ devlink health dump show pci/0000:82:00.1 reporter fw_fatal
-NOTE: This command can run only on PF.
+.. note::
+ This command can run only on PF.
vnic reporter
-------------
@@ -299,4 +302,5 @@ User commands examples:
$ devlink health diagnose pci/0000:82:00.1/65537 reporter vnic
-NOTE: This command can run over all interfaces such as PF/VF and representor ports.
+.. note::
+ This command can run over all interfaces such as PF/VF and representor ports.
--
An old man doll... just what I always wanted! - Clara
On Wed, May 03, 2023 at 04:42:46PM +0700, Bagas Sanjaya wrote:
> Sphinx reports htmldocs warnings:
>
> Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst:287: WARNING: Unexpected indentation.
> Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst:288: WARNING: Block quote ends without a blank line; unexpected unindent.
> Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst:290: WARNING: Unexpected indentation.
>
> Fix above warnings by wrapping diagnostic devlink commands in "vnic
> reporter" section in code blocks to be consistent with other devlink
> command snippets.
>
> Fixes: b0bc615df488ab ("net/mlx5: Add vnic devlink health reporter to PFs/VFs")
> Fixes: cf14af140a5ad0 ("net/mlx5e: Add vnic devlink health reporter to representors")
> Signed-off-by: Bagas Sanjaya <[email protected]>
> ---
> .../device_drivers/ethernet/mellanox/mlx5/devlink.rst | 8 ++++++--
> 1 file changed, 6 insertions(+), 2 deletions(-)
>
Thanks,
Reviewed-by: Leon Romanovsky <[email protected]>
On Wed, May 03, 2023 at 04:42:48PM +0700, Bagas Sanjaya wrote:
> The doc forgets to add separator before numbered lists, which causes the
> lists to be appended to previous paragraph inline instead.
>
> Add the missing separator.
>
> Fixes: f2d51e579359b7 ("net/mlx5: Separate mlx5 driver documentation into multiple pages")
> Signed-off-by: Bagas Sanjaya <[email protected]>
> ---
> .../device_drivers/ethernet/mellanox/mlx5/devlink.rst | 2 ++
> 1 file changed, 2 insertions(+)
>
Thanks,
Reviewed-by: Leon Romanovsky <[email protected]>
On Wed, May 03, 2023 at 04:42:49PM +0700, Bagas Sanjaya wrote:
> Wrap note paragraphs in note:: directive as it better fit for the
> purpose of noting devlink commands.
>
> Fixes: f2d51e579359b7 ("net/mlx5: Separate mlx5 driver documentation into multiple pages")
> Fixes: cf14af140a5ad0 ("net/mlx5e: Add vnic devlink health reporter to representors")
> Signed-off-by: Bagas Sanjaya <[email protected]>
> ---
> .../ethernet/mellanox/mlx5/devlink.rst | 14 +++++++++-----
> 1 file changed, 9 insertions(+), 5 deletions(-)
>
Thanks,
Reviewed-by: Leon Romanovsky <[email protected]>
On Wed, May 03, 2023 at 04:42:45PM +0700, Bagas Sanjaya wrote:
> Here is fixes for mlx5 devlink info documentation. The first fixes
> htmldocs warnings on the mainline, while the rest is formatting fixes.
>
> Bagas Sanjaya (4):
> Documentation: net/mlx5: Wrap vnic reporter devlink commands in code
> blocks
> Documentation: net/mlx5: Use bullet and definition lists for vnic
> counters description
> Documentation: net/mlx5: Add blank line separator before numbered
> lists
> Documentation: net/mlx5: Wrap notes in admonition blocks
>
> .../ethernet/mellanox/mlx5/devlink.rst | 60 ++++++++++++-------
> 1 file changed, 37 insertions(+), 23 deletions(-)
RDMA means "Remote Direct Memory Access" and not "Random Direct Memory Access"
Linux Random Direct Memory Access <[email protected]>
Thanks
>
>
> base-commit: c6d96df9fa2c1d19525239d4262889cce594ce6c
> --
> An old man doll... just what I always wanted! - Clara
>