[PATCH net 4/4] Documentation: net/mlx5: Wrap notes in admonition blocks

Bagas Sanjaya
2023-05-03T09:43:39Z

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