From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: "Bruce Richardson" <bruce.richardson@intel.com>,
"Ciara Power" <ciara.power@intel.com>,
"Morten Brørup" <mb@smartsharesystems.com>
Subject: [PATCH v3 13/13] telemetry: make help command more helpful
Date: Fri, 9 Sep 2022 10:35:23 +0100 [thread overview]
Message-ID: <20220909093523.471727-14-bruce.richardson@intel.com> (raw)
In-Reply-To: <20220909093523.471727-1-bruce.richardson@intel.com>
The /help telemetry command prints out the help text for the given
command passed in as parameter. However, entering /help without any
parameters does not give any useful information as to the fact that you
need to pass in a command to get help on. Update the command so it
prints its own help text when called without any parameters.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Ciara Power <ciara.power@intel.com>
Acked-by: Morten Brørup <mb@smartsharesystems.com>
---
lib/telemetry/telemetry.c | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/lib/telemetry/telemetry.c b/lib/telemetry/telemetry.c
index cf60d27bd4..09febff0ae 100644
--- a/lib/telemetry/telemetry.c
+++ b/lib/telemetry/telemetry.c
@@ -139,15 +139,17 @@ command_help(const char *cmd __rte_unused, const char *params,
struct rte_tel_data *d)
{
int i;
+ /* if no parameters return our own help text */
+ const char *to_lookup = (params == NULL ? cmd : params);
- if (!params)
- return -1;
rte_tel_data_start_dict(d);
rte_spinlock_lock(&callback_sl);
for (i = 0; i < num_callbacks; i++)
- if (strcmp(params, callbacks[i].cmd) == 0) {
- rte_tel_data_add_dict_string(d, params,
- callbacks[i].help);
+ if (strcmp(to_lookup, callbacks[i].cmd) == 0) {
+ if (params == NULL)
+ rte_tel_data_string(d, callbacks[i].help);
+ else
+ rte_tel_data_add_dict_string(d, params, callbacks[i].help);
break;
}
rte_spinlock_unlock(&callback_sl);
--
2.34.1
next prev parent reply other threads:[~2022-09-09 9:37 UTC|newest]
Thread overview: 62+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-23 16:42 [RFC PATCH 0/6] add json string escaping to telemetry Bruce Richardson
2022-06-23 16:42 ` [RFC PATCH 1/6] test/telemetry_json: print success or failure per subtest Bruce Richardson
2022-06-23 16:42 ` [RFC PATCH 2/6] telemetry: fix escaping of invalid json characters Bruce Richardson
2022-06-23 18:34 ` Morten Brørup
2022-06-23 18:39 ` Stephen Hemminger
2022-06-23 18:48 ` Morten Brørup
2022-06-24 8:00 ` Bruce Richardson
2022-06-24 11:16 ` Bruce Richardson
2022-06-24 11:29 ` Morten Brørup
2022-06-24 15:06 ` Stephen Hemminger
2022-06-24 8:03 ` Bruce Richardson
2022-06-23 16:42 ` [RFC PATCH 3/6] telemetry: use json string function for string outputs Bruce Richardson
2022-06-23 16:42 ` [RFC PATCH 4/6] test/telemetry_json: add test for string character escaping Bruce Richardson
2022-06-23 16:42 ` [RFC PATCH 5/6] telemetry: add escaping of strings in arrays Bruce Richardson
2022-06-23 16:42 ` [RFC PATCH 6/6] test/telemetry-json: add test case for escaping " Bruce Richardson
2022-06-23 19:04 ` [RFC PATCH 0/6] add json string escaping to telemetry Morten Brørup
2022-06-24 8:13 ` Bruce Richardson
2022-06-24 9:12 ` Morten Brørup
2022-06-24 9:17 ` Bruce Richardson
2022-06-24 10:22 ` Morten Brørup
2022-07-14 15:42 ` Morten Brørup
2022-07-25 16:38 ` Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 00/13] telemetry JSON escaping and other enhancements Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 01/13] test/telemetry_json: print success or failure per subtest Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 02/13] telemetry: fix escaping of invalid json characters Bruce Richardson
2022-07-26 18:25 ` Morten Brørup
2022-07-27 8:21 ` Bruce Richardson
2022-07-27 1:13 ` fengchengwen
2022-07-27 8:27 ` Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 03/13] test/telemetry_json: add test for string character escaping Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 04/13] telemetry: add escaping of strings in arrays Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 05/13] test/telemetry-json: add test for escaping " Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 06/13] telemetry: limit characters allowed in dictionary names Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 07/13] telemetry: add escaping of strings in dicts Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 08/13] test/telemetry_json: add test for string escaping in objects Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 09/13] telemetry: limit command characters Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 10/13] test/telemetry_data: refactor for maintainability Bruce Richardson
2022-08-23 12:33 ` Power, Ciara
2022-07-25 16:35 ` [PATCH v2 11/13] test/telemetry_data: add test cases for character escaping Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 12/13] telemetry: eliminate duplicate code for json output Bruce Richardson
2022-07-25 16:35 ` [PATCH v2 13/13] telemetry: make help command more helpful Bruce Richardson
2022-07-26 14:36 ` [PATCH v2 00/13] telemetry JSON escaping and other enhancements Morten Brørup
2022-07-27 1:51 ` fengchengwen
2022-07-27 9:12 ` Bruce Richardson
2022-07-27 9:49 ` Morten Brørup
2022-08-23 12:35 ` Power, Ciara
2022-09-09 9:35 ` [PATCH v3 " Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 01/13] telemetry: limit characters allowed in dictionary names Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 02/13] test/telemetry_json: print success or failure per subtest Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 03/13] telemetry: fix escaping of invalid json characters Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 04/13] test/telemetry_json: add test for string character escaping Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 05/13] telemetry: add escaping of strings in arrays Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 06/13] test/telemetry-json: add test for escaping " Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 07/13] telemetry: add escaping of strings in dicts Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 08/13] test/telemetry_json: add test for string escaping in objects Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 09/13] telemetry: limit command characters Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 10/13] test/telemetry_data: refactor for maintainability Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 11/13] test/telemetry_data: add test cases for character escaping Bruce Richardson
2022-09-09 9:35 ` [PATCH v3 12/13] telemetry: eliminate duplicate code for json output Bruce Richardson
2022-09-09 9:35 ` Bruce Richardson [this message]
2022-09-13 0:35 ` [PATCH v3 00/13] telemetry JSON escaping and other enhancements fengchengwen
2022-09-26 11:52 ` David Marchand
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=20220909093523.471727-14-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=ciara.power@intel.com \
--cc=dev@dpdk.org \
--cc=mb@smartsharesystems.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).