| Message ID | 20230510035415.16956-3-bagasdotme@gmail.com (mailing list archive) |
|---|---|
| State | Awaiting Upstream |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | Documentation fixes for Mellanox mlx5 devlink info | expand |
On Wed, May 10, 2023 at 10:54:13AM +0700, Bagas Sanjaya wrote: > "vnic reporter" section contains unformatted description for vnic > counters, which is rendered as one long paragraph instead of list. > > Use bullet and definition lists to match other lists. > > Fixes: b0bc615df488ab ("net/mlx5: Add vnic devlink health reporter to PFs/VFs") > Reviewed-by: Leon Romanovsky <leonro@nvidia.com> > Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> Reviewed-by: Simon Horman <simon.horman@corigine.com>
> Description of the vnic counters: > -total_q_under_processor_handle: number of queues in an error state due to > -an async error or errored command. > -send_queue_priority_update_flow: number of QP/SQ priority/SL update > -events. > -cq_overrun: number of times CQ entered an error state due to an > -overflow. > -async_eq_overrun: number of times an EQ mapped to async events was > -overrun. > -comp_eq_overrun: number of times an EQ mapped to completion events was > -overrun. > -quota_exceeded_command: number of commands issued and failed due to quota > -exceeded. > -invalid_command: number of commands issued and failed dues to any reason > -other than quota exceeded. > -nic_receive_steering_discard: number of packets that completed RX flow > -steering but were discarded due to a mismatch in flow table. > + > +- total_q_under_processor_handle > + number of queues in an error state due to > + an async error or errored command. > +- send_queue_priority_update_flow > + number of QP/SQ priority/SL update events. > +- cq_overrun > + number of times CQ entered an error state due to an overflow. > +- async_eq_overrun > + number of times an EQ mapped to async events was overrun. > + comp_eq_overrun number of times an EQ mapped to completion events was > + overrun. > +- quota_exceeded_command > + number of commands issued and failed due to quota exceeded. > +- invalid_command > + number of commands issued and failed dues to any reason other than quota > + exceeded. Hi Bagas, nit: I think 'dues' should be 'due' here. Might as well get that in when touching the code anyway. Other than that: Reviewed-by: Daniel Machon <daniel.machon@microchip.com> > +- nic_receive_steering_discard > + number of packets that completed RX flow > + steering but were discarded due to a mismatch in flow table.
diff --git a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst index 0f0598caea145f..00687425d8b72d 100644 --- a/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst +++ b/Documentation/networking/device_drivers/ethernet/mellanox/mlx5/devlink.rst @@ -265,22 +265,26 @@ It is responsible for querying the vnic diagnostic counters from fw and displayi them in realtime. Description of the vnic counters: -total_q_under_processor_handle: number of queues in an error state due to -an async error or errored command. -send_queue_priority_update_flow: number of QP/SQ priority/SL update -events. -cq_overrun: number of times CQ entered an error state due to an -overflow. -async_eq_overrun: number of times an EQ mapped to async events was -overrun. -comp_eq_overrun: number of times an EQ mapped to completion events was -overrun. -quota_exceeded_command: number of commands issued and failed due to quota -exceeded. -invalid_command: number of commands issued and failed dues to any reason -other than quota exceeded. -nic_receive_steering_discard: number of packets that completed RX flow -steering but were discarded due to a mismatch in flow table. + +- total_q_under_processor_handle + number of queues in an error state due to + an async error or errored command. +- send_queue_priority_update_flow + number of QP/SQ priority/SL update events. +- cq_overrun + number of times CQ entered an error state due to an overflow. +- async_eq_overrun + number of times an EQ mapped to async events was overrun. + comp_eq_overrun number of times an EQ mapped to completion events was + overrun. +- quota_exceeded_command + number of commands issued and failed due to quota exceeded. +- invalid_command + number of commands issued and failed dues to any reason other than quota + exceeded. +- 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:
"vnic reporter" section contains unformatted description for vnic counters, which is rendered as one long paragraph instead of list. Use bullet and definition lists to match other lists. Fixes: b0bc615df488ab ("net/mlx5: Add vnic devlink health reporter to PFs/VFs") Reviewed-by: Leon Romanovsky <leonro@nvidia.com> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com> --- .../ethernet/mellanox/mlx5/devlink.rst | 36 ++++++++++--------- 1 file changed, 20 insertions(+), 16 deletions(-)