Skip to content

Commit

Permalink
Documentation: net/mlx5: Wrap notes in admonition blocks
Browse files Browse the repository at this point in the history
Wrap note paragraphs in note:: directive as it better fit for the
purpose of noting devlink commands.

Fixes: f2d51e5 ("net/mlx5: Separate mlx5 driver documentation into multiple pages")
Fixes: cf14af1 ("net/mlx5e: Add vnic devlink health reporter to representors")
Reviewed-by: Leon Romanovsky <leonro@nvidia.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Saeed Mahameed <saeedm@nvidia.com>
  • Loading branch information
Bagas Sanjaya authored and Saeed Mahameed committed May 25, 2023
1 parent 92059da commit bb72b94
Showing 1 changed file with 9 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down Expand Up @@ -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
-----------------
Expand All @@ -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
-------------
Expand Down Expand Up @@ -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.

0 comments on commit bb72b94

Please sign in to comment.