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 34E9BA0032; Tue, 12 Jul 2022 11:10:01 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C266641109; Tue, 12 Jul 2022 11:10:00 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id 42DBF410EF for ; Tue, 12 Jul 2022 11:09:59 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1657616999; x=1689152999; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=ApwG1psiHc1YVkKfGf40/h8MLgnfUyp9GKaLvL3M3Yo=; b=EpGyYi/F3ZGWkgv/01fnv+u0ofBhkvI/R+p6lOi730wgCuc+G9eofQ8Y fAw5o7Z8gJbC34p+ZJE1yomSR/Kg9LyrrthNi23zM2RWF1XKjOEe9y5aN KwC/kwK7vHjyRaynyCEXpsr/4jcH20kwrwkZgIRXz4UsT5kOWULmVIWYk dCqJ1DbnO2g43P5e+ecaWzg+3+/7to9+93547zgwzJ5Z/XJ9gj5KRKaNF qrIKKHXFZzjQCtmQog4ex565cqMLYzWOHlLwFIoipP7/mfSKzkEv4wanC ePKWLu938D0iUmBczBqC6ox3u8drZTIRg6bJDhcpi6sgl5MDuFRPOe7ss Q==; X-IronPort-AV: E=McAfee;i="6400,9594,10405"; a="284909203" X-IronPort-AV: E=Sophos;i="5.92,265,1650956400"; d="scan'208";a="284909203" Received: from orsmga008.jf.intel.com ([10.7.209.65]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Jul 2022 02:09:58 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,265,1650956400"; d="scan'208";a="622430865" Received: from silpixa00401385.ir.intel.com (HELO silpixa00401385.ger.corp.intel.com.) ([10.237.223.125]) by orsmga008.jf.intel.com with ESMTP; 12 Jul 2022 02:09:56 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Andrew Rybchenko , =?UTF-8?q?Morten=20Br=C3=83=C2=B8rup?= , David Marchand Subject: [PATCH v3] doc: add deprecation for restrictions in telemetry naming Date: Tue, 12 Jul 2022 10:09:52 +0100 Message-Id: <20220712090952.205258-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20220707133931.752248-1-bruce.richardson@intel.com> References: <20220707133931.752248-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 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 Acked-by: Andrew Rybchenko Acked-by: Morten Brørup Acked-by: David Marchand --- 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