DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH] doc/guides: fix telemetry register command example
@ 2020-05-22 16:27 Ciara Power
  2020-05-22 16:44 ` Laatz, Kevin
  0 siblings, 1 reply; 3+ messages in thread
From: Ciara Power @ 2020-05-22 16:27 UTC (permalink / raw)
  To: kevin.laatz; +Cc: dev, Ciara Power

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


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [dpdk-dev] [PATCH] doc/guides: fix telemetry register command example
  2020-05-22 16:27 [dpdk-dev] [PATCH] doc/guides: fix telemetry register command example Ciara Power
@ 2020-05-22 16:44 ` Laatz, Kevin
  2020-05-24 16:52   ` Thomas Monjalon
  0 siblings, 1 reply; 3+ messages in thread
From: Laatz, Kevin @ 2020-05-22 16:44 UTC (permalink / raw)
  To: Ciara Power; +Cc: dev

On 22/05/2020 17:27, Ciara Power wrote:
> 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(-)

Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [dpdk-dev] [PATCH] doc/guides: fix telemetry register command example
  2020-05-22 16:44 ` Laatz, Kevin
@ 2020-05-24 16:52   ` Thomas Monjalon
  0 siblings, 0 replies; 3+ messages in thread
From: Thomas Monjalon @ 2020-05-24 16:52 UTC (permalink / raw)
  To: Ciara Power; +Cc: dev, Laatz, Kevin

22/05/2020 18:44, Laatz, Kevin:
> On 22/05/2020 17:27, Ciara Power wrote:
> > 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>
> 
> Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>

Applied, thanks



^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-05-24 16:52 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-22 16:27 [dpdk-dev] [PATCH] doc/guides: fix telemetry register command example Ciara Power
2020-05-22 16:44 ` Laatz, Kevin
2020-05-24 16:52   ` Thomas Monjalon

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ http://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git