From: Sivaprasad Tummala <sivaprasad.tummala@amd.com>
To: <mb@smartsharesystems.com>, <david.marchand@redhat.com>,
<ktraynor@redhat.com>, <thomas@monjalon.net>,
<konstantin.ananyev@huawei.com>, <konstantin.v.ananyev@yandex.ru>,
<bruce.richardson@intel.com>, <maxime.coquelin@redhat.com>,
<aconole@redhat.com>, <ferruh.yigit@amd.com>
Cc: <dev@dpdk.org>
Subject: [PATCH] doc: document telemetry command name restrictions
Date: Mon, 6 Oct 2025 09:47:12 +0000 [thread overview]
Message-ID: <20251006094712.180432-1-sivaprasad.tummala@amd.com> (raw)
Telemetry command names must contain only alphanumeric characters
(`A-Z`, `a-z`, `0-9`), underscore (`_`), and forward slash (`/`).
Other characters, including hyphens (`-`), are not allowed and
cause registration to fail.
This patch updates the documentation to explicitly state these
restrictions and highlights the existing invalid example
"/l3fwd-power/stats" (in l3fwd-power app).
Signed-off-by: Sivaprasad Tummala <sivaprasad.tummala@amd.com>
---
doc/guides/prog_guide/telemetry_lib.rst | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/doc/guides/prog_guide/telemetry_lib.rst b/doc/guides/prog_guide/telemetry_lib.rst
index 32f525a67f..6ae5067474 100644
--- a/doc/guides/prog_guide/telemetry_lib.rst
+++ b/doc/guides/prog_guide/telemetry_lib.rst
@@ -157,6 +157,10 @@ command. An example command being registered is shown below:
rte_telemetry_register_cmd("/example_lib/string_example", handle_string,
"Returns an example string. Takes no parameters");
+The command name **must consist only of alphanumeric characters (`A-Z`, `a-z`,
+`0-9`) and the special characters underscore (`_`) and forward slash (`/`)**.
+Any other characters, including spaces, are not permitted and will cause the
+command registration to fail.
Using Commands
--------------
--
2.43.0
reply other threads:[~2025-10-06 9:47 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20251006094712.180432-1-sivaprasad.tummala@amd.com \
--to=sivaprasad.tummala@amd.com \
--cc=aconole@redhat.com \
--cc=bruce.richardson@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@amd.com \
--cc=konstantin.ananyev@huawei.com \
--cc=konstantin.v.ananyev@yandex.ru \
--cc=ktraynor@redhat.com \
--cc=maxime.coquelin@redhat.com \
--cc=mb@smartsharesystems.com \
--cc=thomas@monjalon.net \
/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).