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 D2AF4A0543; Thu, 7 Jul 2022 15:39:41 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C41D1406B4; Thu, 7 Jul 2022 15:39:41 +0200 (CEST) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by mails.dpdk.org (Postfix) with ESMTP id B376C4069D for ; Thu, 7 Jul 2022 15:39:39 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1657201179; x=1688737179; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=Gt3DNNfIWKeASc7AyuIRjiC2A+UUA2h4l68FnNqSJ2Y=; b=PvYpQ+MHjWnEaZX4nnU3s7Aginpi9DrEdhLzm3sD17n5gKFUjsvLOFxZ 4V6mHMO9m8e2NK2gvluv7u13vGnNMy93PUIlsllGLKN+T6Kf1aKlBnGct t/v0T4vZ69w7K3aL3MDCnB3pUR7tEN8gxQ3ULPECXmW4O26W181CjONFp DcNQTQPmeB2McrCNdTBvuPRF1PvuM7sRqjwLN3DqfWBK0VZvf3t/8Oi+d jzLackcuMsWqBqx5Dv8HYNqZn39Um+/5G+fFMT2sueglmP2oWegqzGOQV M1G8dWLXCv916ozju4uUSWvB0VW0I5ZQXjvgW2BGkhqivKg2ND84gQOxt A==; X-IronPort-AV: E=McAfee;i="6400,9594,10400"; a="309583999" X-IronPort-AV: E=Sophos;i="5.92,253,1650956400"; d="scan'208";a="309583999" Received: from orsmga001.jf.intel.com ([10.7.209.18]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 07 Jul 2022 06:39:38 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.92,253,1650956400"; d="scan'208";a="626325607" Received: from silpixa00401385.ir.intel.com (HELO silpixa00401385.ger.corp.intel.com.) ([10.237.222.133]) by orsmga001.jf.intel.com with ESMTP; 07 Jul 2022 06:39:37 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , mb@smartsharesystems.com, stephen@networkplumber.org, ciara.power@intel.com Subject: [PATCH] doc: add deprecation for restrictions in telemetry naming Date: Thu, 7 Jul 2022 14:39:31 +0100 Message-Id: <20220707133931.752248-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 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 --- 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 telemetry commands will + be similarly limited. + * 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