Skip to content

Commit bb72b94

Browse files
bagasmeSaeed Mahameed
authored andcommitted
Documentation: net/mlx5: Wrap notes in admonition blocks
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>
1 parent 92059da commit bb72b94

1 file changed

Lines changed: 9 additions & 5 deletions

File tree

  • Documentation/networking/device_drivers/ethernet/mellanox/mlx5

Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,8 @@ User commands examples:
182182

183183
$ devlink health diagnose pci/0000:82:00.0 reporter tx
184184

185-
NOTE: This command has valid output only when interface is up, otherwise the command has empty output.
185+
.. note::
186+
This command has valid output only when interface is up, otherwise the command has empty output.
186187

187188
- Show number of tx errors indicated, number of recover flows ended successfully,
188189
is autorecover enabled and graceful period from last recover::
@@ -234,8 +235,9 @@ User commands examples:
234235

235236
$ devlink health dump show pci/0000:82:00.0 reporter fw
236237

237-
NOTE: This command can run only on the PF which has fw tracer ownership,
238-
running it on other PF or any VF will return "Operation not permitted".
238+
.. note::
239+
This command can run only on the PF which has fw tracer ownership,
240+
running it on other PF or any VF will return "Operation not permitted".
239241

240242
fw fatal reporter
241243
-----------------
@@ -258,7 +260,8 @@ User commands examples:
258260

259261
$ devlink health dump show pci/0000:82:00.1 reporter fw_fatal
260262

261-
NOTE: This command can run only on PF.
263+
.. note::
264+
This command can run only on PF.
262265

263266
vnic reporter
264267
-------------
@@ -299,4 +302,5 @@ User commands examples:
299302

300303
$ devlink health diagnose pci/0000:82:00.1/65537 reporter vnic
301304

302-
NOTE: This command can run over all interfaces such as PF/VF and representor ports.
305+
.. note::
306+
This command can run over all interfaces such as PF/VF and representor ports.

0 commit comments

Comments
 (0)