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 9B365A0032; Tue, 12 Jul 2022 11:04:36 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 3B86C41109; Tue, 12 Jul 2022 11:04:36 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id A4F80410EF for ; Tue, 12 Jul 2022 11:04:34 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1657616674; x=1689152674; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=LUBHdvubm5v48/wgyNaHQ7stAM2ThcaeNonv1G8S9Pw=; b=Ov6yi05yV4bJUK3TC25Tvnjynf5hidVah/V2r+Qog9mrgD6yownD3VpH mHMtEH65ffy+1AQH9W9I6rx3p56i1YBbiIghrZpAByi3H1WplTDPuc31E tHvzIidearAxQ6yJcqiBiaDkD2E7kmOIjBkviSU4IsrTcGwUAIZ7zVHYe GBXhMwsehFzhXAjbBA+9/ZyyGeI2Q4Pcq2hUGxSxxJRmzCAD6IZJVzcLM l6Alkc/5hwkccfpyA0U2MSCYUg7c8A2U78YYkpl4PT0Ea38lI9ykHa7ur xNJFEBvfMEx27XSn/BM9NBhC3997XqdkCrWrD4hsRGhAUl6IWUDxrF7sI A==; X-IronPort-AV: E=McAfee;i="6400,9594,10405"; a="284908263" X-IronPort-AV: E=Sophos;i="5.92,265,1650956400"; d="scan'208";a="284908263" Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Jul 2022 02:04:32 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,265,1650956400"; d="scan'208";a="841315401" Received: from silpixa00401385.ir.intel.com (HELO silpixa00401385.ger.corp.intel.com.) ([10.237.223.125]) by fmsmga006.fm.intel.com with ESMTP; 12 Jul 2022 02:04:29 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , mb@smartsharesystems.com, stephen@networkplumber.org, ciara.power@intel.com, Andrew Rybchenko , David Marchand Subject: [PATCH v2] doc: add deprecation for restrictions in telemetry naming Date: Tue, 12 Jul 2022 10:04:12 +0100 Message-Id: <20220712090412.205122-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. Cc: mb@smartsharesystems.com Cc: stephen@networkplumber.org Cc: ciara.power@intel.com Signed-off-by: Bruce Richardson [1] http://inbox.dpdk.org/dev/20220623164245.561371-1-bruce.richardson@intel.com/#r 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