[PATCH] doc: add deprecation for restrictions in telemetry naming

[Morten Brørup]

> From: Bruce Richardson [mailto:bruce.richardson at intel.com]
> Sent: Thursday, 7 July 2022 15.40
> 
> 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.
> 
> Cc: mb at smartsharesystems.com
> Cc: stephen at networkplumber.org
> Cc: ciara.power at intel.com
> 
> Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
> 
> [1] http://inbox.dpdk.org/dev/20220623164245.561371-1-
> bruce.richardson at intel.com/#r
> ---
>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 4e5b23c53d..9366690ec5 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -119,6 +119,12 @@ 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

json -> JSON

> telemetry commands will
> +  be similarly limited.

Perhaps also add a comment about parameters to telemetry commands, for completeness.

> +
>  * 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
> 

Acked-by: Morten Brørup <mb at smartsharesystems.com>