From 1474a341d547bf0484c0b8a3f060dc41054e24aa Mon Sep 17 00:00:00 2001 From: Ciara Power Date: Fri, 22 May 2020 17:27:41 +0100 Subject: [PATCH] doc: fix telemetry registration example 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 Reviewed-by: Kevin Laatz --- 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 d8f5856ee5..8563a7200e 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.20.1