DPDK patches and discussions
 help / color / mirror / Atom feed
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: "Bruce Richardson" <bruce.richardson@intel.com>,
	"Andrew Rybchenko" <andrew.rybchenko@oktetlabs.ru>,
	"Morten Brørup" <mb@smartsharesystems.com>,
	"David Marchand" <david.marchand@redhat.com>
Subject: [PATCH v3] doc: add deprecation for restrictions in telemetry naming
Date: Tue, 12 Jul 2022 10:09:52 +0100	[thread overview]
Message-ID: <20220712090952.205258-1-bruce.richardson@intel.com> (raw)
In-Reply-To: <20220707133931.752248-1-bruce.richardson@intel.com>

Following discussion on-list [1], we will look to limited the allowed
characters in names for items in telemetry. This will simplify the
escaping needed for json output, or any future output formats. The lists
will initially be minimal, since expansion to allow more characters can
be done without affecting compatibility, while reducing the set cannot.

[1] http://inbox.dpdk.org/dev/20220623164245.561371-1-bruce.richardson@intel.com/#r

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>
Acked-by: Morten Brørup <mb@smartsharesystems.com>
Acked-by: David Marchand <david.marchand@redhat.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4e5b23c53d..6ef93758d4 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -119,6 +119,13 @@ Deprecation Notices
 * metrics: The function ``rte_metrics_init`` will have a non-void return
   in order to notify errors instead of calling ``rte_exit``.
 
+* telemetry: The allowed characters in names for dictionary values will be limited to
+  alphanumeric characters and a small subset of additional printable characters.
+  This will ensure that all dictionary parameter names can be output without escaping
+  in JSON - or in any future output format used. Names for the telemetry commands will
+  be similarly limited. The parameters for telemetry commands are unaffected by this
+  change.
+
 * raw/ioat: The ``ioat`` rawdev driver has been deprecated, since it's
   functionality is provided through the new ``dmadev`` infrastructure.
   To continue to use hardware previously supported by the ``ioat`` rawdev driver,
-- 
2.34.1


  parent reply	other threads:[~2022-07-12  9:10 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-07 13:39 [PATCH] " Bruce Richardson
2022-07-07 15:16 ` Andrew Rybchenko
2022-07-07 22:06 ` Morten Brørup
2022-07-11 10:53   ` Bruce Richardson
2022-07-11 11:40     ` Morten Brørup
2022-07-11 10:43 ` Power, Ciara
2022-07-11 10:45 ` David Marchand
2022-07-12  9:04 ` [PATCH v2] " Bruce Richardson
2022-07-12  9:09 ` Bruce Richardson [this message]
2022-07-15 16:30   ` [PATCH v3] " 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=20220712090952.205258-1-bruce.richardson@intel.com \
    --to=bruce.richardson@intel.com \
    --cc=andrew.rybchenko@oktetlabs.ru \
    --cc=david.marchand@redhat.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).