From: Ciara Power <ciara.power@intel.com>
To: kevin.laatz@intel.com
Cc: dev@dpdk.org, Ciara Power <ciara.power@intel.com>
Subject: [dpdk-dev] [PATCH] doc/guides: fix telemetry register command example
Date: Fri, 22 May 2020 17:27:41 +0100 [thread overview]
Message-ID: <20200522162741.27672-1-ciara.power@intel.com> (raw)
The example shown for registering telemetry commands was previously
missing the help text parameter.
Fixes: 24cd1b529f35 ("doc: update telemetry guides")
Signed-off-by: Ciara Power <ciara.power@intel.com>
---
doc/guides/prog_guide/telemetry_lib.rst | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/doc/guides/prog_guide/telemetry_lib.rst b/doc/guides/prog_guide/telemetry_lib.rst
index d8f5856ee..8563a7200 100644
--- a/doc/guides/prog_guide/telemetry_lib.rst
+++ b/doc/guides/prog_guide/telemetry_lib.rst
@@ -21,14 +21,18 @@ Registering Commands
Libraries and applications must register commands to make their information
available via the Telemetry library. This involves providing a string command
-in the required format ("/library/command"), and the callback function that
-will handle formatting the information when required. An example showing ethdev
-commands being registered is shown below:
+in the required format ("/library/command"), the callback function that
+will handle formatting the information when required, and help text for the
+command. An example showing ethdev commands being registered is shown below:
.. code-block:: c
- rte_telemetry_register_cmd("/ethdev/list", handle_port_list);
- rte_telemetry_register_cmd("/ethdev/xstats", handle_port_xstats);
+ rte_telemetry_register_cmd("/ethdev/list", handle_port_list,
+ "Returns list of available ethdev ports. Takes no parameters");
+ rte_telemetry_register_cmd("/ethdev/xstats", handle_port_xstats,
+ "Returns the extended stats for a port. Parameters: int port_id");
+ rte_telemetry_register_cmd("/ethdev/link_status", handle_port_link_status,
+ "Returns the link status for a port. Parameters: int port_id");
Formatting JSON response
--
2.17.1
next reply other threads:[~2020-05-22 16:30 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-22 16:27 Ciara Power [this message]
2020-05-22 16:44 ` Laatz, Kevin
2020-05-24 16:52 ` Thomas Monjalon
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=20200522162741.27672-1-ciara.power@intel.com \
--to=ciara.power@intel.com \
--cc=dev@dpdk.org \
--cc=kevin.laatz@intel.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).