Commit bb72b94c authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Saeed Mahameed
Browse files

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: f2d51e57 ("net/mlx5: Separate mlx5 driver documentation into multiple pages")
Fixes: cf14af14 ("net/mlx5e: Add vnic devlink health reporter to representors")
Reviewed-by: default avatarLeon Romanovsky <leonro@nvidia.com>
Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: default avatarSaeed Mahameed <saeedm@nvidia.com>
parent 92059da6

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

+9 −5
Original line number Diff line number Diff line
@@ -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,7 +235,8 @@ 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,

.. 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.