From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Networking <netdev@vger.kernel.org>,
Linux Random Direct Memory Access <linux-rdma@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux Networking <linux-kernel@vger.kernel.org>
Cc: Saeed Mahameed <saeedm@nvidia.com>,
Leon Romanovsky <leon@kernel.org>,
"David S. Miller" <davem@davemloft.net>,
Eric Dumazet <edumazet@google.com>,
Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com>,
Jonathan Corbet <corbet@lwn.net>,
Bagas Sanjaya <bagasdotme@gmail.com>,
Gal Pressman <gal@nvidia.com>, Tariq Toukan <tariqt@nvidia.com>,
Maher Sanalla <msanalla@nvidia.com>,
Rahul Rameshbabu <rrameshbabu@nvidia.com>,
Moshe Shemesh <moshe@nvidia.com>
Subject: [PATCH net 2/4] Documentation: net/mlx5: Use bullet and definition lists for vnic counters description
Date: Wed, 3 May 2023 16:42:47 +0700 [thread overview]
Message-ID: <20230503094248.28931-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20230503094248.28931-1-bagasdotme@gmail.com>
"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")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
.../ethernet/mellanox/mlx5/devlink.rst | 36 ++++++++++---------
1 file changed, 20 insertions(+), 16 deletions(-)
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:
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2023-05-03 9:43 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-03 9:42 [PATCH net 0/4] Documentation fixes for Mellanox mlx5 devlink info Bagas Sanjaya
2023-05-03 9:42 ` [PATCH net 1/4] Documentation: net/mlx5: Wrap vnic reporter devlink commands in code blocks Bagas Sanjaya
2023-05-03 10:47 ` Leon Romanovsky
2023-05-03 9:42 ` Bagas Sanjaya [this message]
2023-05-03 10:47 ` [PATCH net 2/4] Documentation: net/mlx5: Use bullet and definition lists for vnic counters description Leon Romanovsky
2023-05-03 9:42 ` [PATCH net 3/4] Documentation: net/mlx5: Add blank line separator before numbered lists Bagas Sanjaya
2023-05-03 10:47 ` Leon Romanovsky
2023-05-03 9:42 ` [PATCH net 4/4] Documentation: net/mlx5: Wrap notes in admonition blocks Bagas Sanjaya
2023-05-03 10:47 ` Leon Romanovsky
2023-05-03 10:49 ` [PATCH net 0/4] Documentation fixes for Mellanox mlx5 devlink info Leon Romanovsky
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230503094248.28931-3-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=gal@nvidia.com \
--cc=kuba@kernel.org \
--cc=leon@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rdma@vger.kernel.org \
--cc=moshe@nvidia.com \
--cc=msanalla@nvidia.com \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=rrameshbabu@nvidia.com \
--cc=saeedm@nvidia.com \
--cc=tariqt@nvidia.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).