d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: announce restrictions in telemetry naming

Browse Source 
Following discussion on-list [1], we will look to limit 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: Ciara Power <ciara.power@intel.com>
Acked-by: David Marchand <david.marchand@redhat.com>
This commit is contained in:
Bruce Richardson 2022-07-12 10:09:52 +01:00 committed by Thomas Monjalon
parent cf905d31df
commit ce52f742c8
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/guides/rel_notes/deprecation.rst
View File

@ -144,6 +144,14 @@ 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,