From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D8088A0543; Fri, 8 Jul 2022 00:06:33 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 6EA214069D; Fri, 8 Jul 2022 00:06:33 +0200 (CEST) Received: from smartserver.smartsharesystems.com (smartserver.smartsharesystems.com [77.243.40.215]) by mails.dpdk.org (Postfix) with ESMTP id 0FD8B40041 for ; Fri, 8 Jul 2022 00:06:32 +0200 (CEST) X-MimeOLE: Produced By Microsoft Exchange V6.5 Content-class: urn:content-classes:message MIME-Version: 1.0 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Subject: RE: [PATCH] doc: add deprecation for restrictions in telemetry naming Date: Fri, 8 Jul 2022 00:06:31 +0200 Message-ID: <98CBD80474FA8B44BF855DF32C47DC35D871B2@smartserver.smartshare.dk> In-Reply-To: <20220707133931.752248-1-bruce.richardson@intel.com> X-MS-Has-Attach: X-MS-TNEF-Correlator: Thread-Topic: [PATCH] doc: add deprecation for restrictions in telemetry naming Thread-Index: AdiSBwQ/pM69UxUbSRaWTIz6+6T41gARhTaQ References: <20220707133931.752248-1-bruce.richardson@intel.com> From: =?iso-8859-1?Q?Morten_Br=F8rup?= To: "Bruce Richardson" , Cc: , X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org > From: Bruce Richardson [mailto:bruce.richardson@intel.com] > Sent: Thursday, 7 July 2022 15.40 >=20 > 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. >=20 > Cc: mb@smartsharesystems.com > Cc: stephen@networkplumber.org > Cc: ciara.power@intel.com >=20 > Signed-off-by: Bruce Richardson >=20 > [1] http://inbox.dpdk.org/dev/20220623164245.561371-1- > bruce.richardson@intel.com/#r > --- > doc/guides/rel_notes/deprecation.rst | 6 ++++++ > 1 file changed, 6 insertions(+) >=20 > 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``. >=20 > +* 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 >=20 Acked-by: Morten Br=F8rup