From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 9651BA0526; Fri, 24 Jul 2020 13:45:17 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 2A2AB1C010; Fri, 24 Jul 2020 13:45:16 +0200 (CEST) Received: from mga06.intel.com (mga06.intel.com [134.134.136.31]) by dpdk.org (Postfix) with ESMTP id 8426E1BFE7 for ; Fri, 24 Jul 2020 13:45:14 +0200 (CEST) IronPort-SDR: SIzWlp8FOmmS/3foE53ShGCEoqfqxsu8MXbHfwgd8ew57Kg/vzXGqOTcW+OTQmqc7CDsZCktHc s56tRlnp0chg== X-IronPort-AV: E=McAfee;i="6000,8403,9691"; a="212228804" X-IronPort-AV: E=Sophos;i="5.75,390,1589266800"; d="scan'208";a="212228804" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 24 Jul 2020 04:45:13 -0700 IronPort-SDR: MQ2UWLxpXOwtJ+slWdxI2wGPidrTYFIGCmgEBnX/oA4QngklHfKWKi0AzOh1wL1+JqaUdvilXy KgG8On6AVkEw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.75,390,1589266800"; d="scan'208";a="288967246" Received: from fmsmsx105.amr.corp.intel.com ([10.18.124.203]) by orsmga006.jf.intel.com with ESMTP; 24 Jul 2020 04:45:13 -0700 Received: from fmsmsx153.amr.corp.intel.com (10.18.125.6) by FMSMSX105.amr.corp.intel.com (10.18.124.203) with Microsoft SMTP Server (TLS) id 14.3.439.0; Fri, 24 Jul 2020 04:45:12 -0700 Received: from FMSEDG001.ED.cps.intel.com (10.1.192.133) by FMSMSX153.amr.corp.intel.com (10.18.125.6) with Microsoft SMTP Server (TLS) id 14.3.439.0; Fri, 24 Jul 2020 04:45:12 -0700 Received: from NAM10-DM6-obe.outbound.protection.outlook.com (104.47.58.107) by edgegateway.intel.com (192.55.55.68) with Microsoft SMTP Server (TLS) id 14.3.439.0; Fri, 24 Jul 2020 04:45:12 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=LZPttsiJX9SvlkkRTS9z3oIU0Q9xwZtBx3HsFxc59zcFzHHgCIjIxu6V9Qc/Ny1YG9l5SNJ3NvLhQQm1NzniJ058bMv6I0YgzlcR3ZAf/cpAagjhphhsdS9NloZnuoETlxP0rjKkn2WVRh/8JnwZGdBD5TnXbFGEdHK+Bt4E9MabwP3AqHY4GmrlUrLUtIQqNriTS1lm4Ghmocf5NPsoMTm2KRcnI0TagMgXjA5FXMT5MjghSSZKklzoRPkfAHWS7MQ26JWFVMsJp4gHiNHrmh116p2NyxIiLuNjkYaUZRX1sxnkT1AHNDn7EXaKnWvZJmulwVBnL6YloJzkZLQLIQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=L2zqe2XMuRYVxOQoEVAnSiTkP/GQ/b0w2gDcOvt7lKk=; b=jsYnCxECLTDMG7cpJtP2Q7x9agWV0qw5W5QV2v08SYlB8by/FEzKJxXaLB9hCBtDHRgRKyj6B0v1vjvYaVM6ciaBsRLNZ2gAFymX2V0pxl+mmvTJ91+OKMWm7K9CUtF0PQLLigUO7UyaFNV193YHo+gUjP4mKXOKp2g8nMiU+MSf4hEfTtAmwRePAXoAFg9fss+fRyeJFUHinw4tuEm/ZSMb+A09dd6sHrsQ2epjWj+Hxq2GJp2WgfCqtF+xVAZ1mzLyk5f7Wo2jF1vVicmlZKzCUcPQFrsbTamE+At2UA/3xQXhxdsdjx/iHF7mtplOCDzxXzpZvYhMBspm1MTW3Q== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=intel.onmicrosoft.com; s=selector2-intel-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=L2zqe2XMuRYVxOQoEVAnSiTkP/GQ/b0w2gDcOvt7lKk=; b=vKDenZ2XUUJk8UPx4d8KoxpFw4G4EXBkwCJKTjMtkjSyt0ESPpeIaNiSpuvfyTXLk7lBGojNsZntx36ynIeWQUupVb7qfBMD4LpokUMIlH2Oe7PzBrNs0f0d5f8DjO2w84R4VilJJ1dVqSIz7IIpKOg7mj4ficINn7wOc0EEa8U= Received: from DM6PR11MB2555.namprd11.prod.outlook.com (2603:10b6:5:c5::33) by DM6PR11MB3785.namprd11.prod.outlook.com (2603:10b6:5:13f::30) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3216.24; Fri, 24 Jul 2020 11:45:11 +0000 Received: from DM6PR11MB2555.namprd11.prod.outlook.com ([fe80::75c7:27bf:b5af:a483]) by DM6PR11MB2555.namprd11.prod.outlook.com ([fe80::75c7:27bf:b5af:a483%5]) with mapi id 15.20.3216.026; Fri, 24 Jul 2020 11:45:11 +0000 From: "Power, Ciara" To: "Laatz, Kevin" CC: "dev@dpdk.org" , "Richardson, Bruce" , "thomas@monjalon.net" Thread-Topic: [PATCH v3] doc: add more detail to telemetry guides Thread-Index: AQHWYa1Dsl6470ib4kGP36TJ3XuJqakWm8hg Date: Fri, 24 Jul 2020 11:45:10 +0000 Message-ID: References: <20200721160924.62082-1-ciara.power@intel.com> <20200724112033.24860-1-ciara.power@intel.com> In-Reply-To: <20200724112033.24860-1-ciara.power@intel.com> Accept-Language: en-IE, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-version: 11.2.0.6 dlp-product: dlpe-windows dlp-reaction: no-action authentication-results: intel.com; dkim=none (message not signed) header.d=none;intel.com; dmarc=none action=none header.from=intel.com; x-originating-ip: [37.228.239.229] x-ms-publictraffictype: Email x-ms-office365-filtering-correlation-id: 4807c2b0-045f-4996-1200-08d82fc70589 x-ms-traffictypediagnostic: DM6PR11MB3785: x-ld-processed: 46c98d88-e344-4ed4-8496-4ed7712e255d,ExtAddr x-ms-exchange-transport-forked: True x-microsoft-antispam-prvs: x-ms-oob-tlc-oobclassifiers: OLM:5236; x-ms-exchange-senderadcheck: 1 x-microsoft-antispam: BCL:0; x-microsoft-antispam-message-info: ansntxBmOWzPxW+p6kUhY7f11z6QEXRPCIQDsTHNDtzGFMdmiT6FDstD31bR7FzuuVaANxeQHTGr2GjVi8TejFc4bDkSonsIbST11ER6H3RUNzOqx0vdrU0HZyocJKtHWpiGAJZJDym5hGh2fG7KPVSkkTaNnqcPLetForM81kAPaLLKPRTzePl7ZEbEWhRV+DaXRZX7YQJHaIIBnPAVG91iLY/6D1bcJVe2wSviRI5qYK36CNg5EzerdKgM7thm6ijFBxqzHXCVzHVVGHJLuyvmMpgKNuCwgq7b2UZ6+YoB/lUwfVnmSiBnNfEBo1QjKL1fIk42UJwhecoyPTLHAw== x-forefront-antispam-report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DM6PR11MB2555.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFTY:; SFS:(4636009)(396003)(136003)(39860400002)(366004)(376002)(346002)(54906003)(66446008)(64756008)(66476007)(66556008)(6636002)(6862004)(83380400001)(66946007)(71200400001)(33656002)(6506007)(5660300002)(26005)(316002)(2906002)(76116006)(52536014)(8676002)(9686003)(55016002)(86362001)(4326008)(186003)(7696005)(478600001)(8936002); DIR:OUT; SFP:1102; x-ms-exchange-antispam-messagedata: woxw3ieUvOrVdy3L91nDg9CFpkFf0Y+sW65crTYX+x+Zod6/Kda7mbqb3boON4VELMC34mqEfS0CmKMkrgyhbC0xqErrmXMWAuoLyPyFQ2j9cUWwg253qtlHqxSF1YNzbqH3cr9Gq8m97jgEhhaLyz7aoy/uCjDmX2Vu1dc5TUaJD32E3/a619K1AnTX98fA/VEp9dgf4HIMPr0reVrru8B19+yUn8/cNqyLLvYo4GbAbso4LjzNZBbJQ9giEzacDjvcNGlIFdgHtqaXnSRUrLAASkt70X9CW1zYqqGmwweOmeQ7/pooRKSDB9hI6mOoC6GA0wqRtAe/P+F1Vn/cxL11j5/35o6vdYk1Fr+qeSUgCYd2OL9Oy1kaSao93GOOMhBcX/DrrsLIcEFrBWc4DpiMBL4DOP3Yrmx00QkPUZDVRkwP4BSDW4IBQh10DRGHZ1FohU/JvM747U2aA4Q/3kSJDK70QZgpJ98WIy8GQKpZgWg6g4AKmWcJ3SnpcMZ4 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-AuthSource: DM6PR11MB2555.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 4807c2b0-045f-4996-1200-08d82fc70589 X-MS-Exchange-CrossTenant-originalarrivaltime: 24 Jul 2020 11:45:10.9442 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-mailboxtype: HOSTED X-MS-Exchange-CrossTenant-userprincipalname: 6v761pLhPlZlMgYA3uiM0NX9cXrpQKcRy/ZU2b03FaZLVOryJsyDMLmU8PwYTS1mSo7fMA2TEG6Hug/27Qhz7Q== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR11MB3785 X-OriginatorOrg: intel.com Subject: Re: [dpdk-dev] [PATCH v3] doc: add more detail to telemetry guides X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" >-----Original Message----- >From: Power, Ciara >Sent: Friday 24 July 2020 12:21 >To: Laatz, Kevin >Cc: dev@dpdk.org; Richardson, Bruce ; >thomas@monjalon.net; Power, Ciara >Subject: [PATCH v3] doc: add more detail to telemetry guides > >This patch adds examples to the Telemetry HowTo guide, to demonstrate >commands that use parameters. The programmer's guide is also modified to >include details on writing a callback function for a new command. > >Signed-off-by: Ciara Power > >--- >v3: > - Replaced direct code examples with generic examples. > - Replaced ref label with :doc: syntax to link guides. > - Replaced console code-block label with :: on previous lines. > - Added links to API doc. > - Modified some formatting. >v2: > - Replaced examples of using commands in the programmer's guide with > a link to the HowTo guide. > - Added an example showing the use of a single string value. > - Replaced inline functions with a synthetic example function below > the list of parameters. >--- > doc/guides/howto/telemetry.rst | 67 ++++++---- > doc/guides/prog_guide/telemetry_lib.rst | 160 +++++++++++++++++++----- > 2 files changed, 172 insertions(+), 55 deletions(-) > >diff --git a/doc/guides/howto/telemetry.rst >b/doc/guides/howto/telemetry.rst index b4a34ed674..e7b5434152 100644 >--- a/doc/guides/howto/telemetry.rst >+++ b/doc/guides/howto/telemetry.rst >@@ -29,17 +29,13 @@ Telemetry Initialization > I forgot to preserve the Ack from v2. Acked-by: Bruce Richardson