From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id C15FC42EB9;
	Wed, 19 Jul 2023 16:02:01 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 51C6F40DFD;
	Wed, 19 Jul 2023 16:02:01 +0200 (CEST)
Received: from mga03.intel.com (mga03.intel.com [134.134.136.65])
 by mails.dpdk.org (Postfix) with ESMTP id 6DCBD40685
 for <dev@dpdk.org>; Wed, 19 Jul 2023 16:01:58 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
 d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
 t=1689775319; x=1721311319;
 h=date:from:to:cc:subject:message-id:references:
 in-reply-to:mime-version;
 bh=WHzxEZecz0dpNBbu6j2ChHIzQPy61b0ULSK/pHUxcAs=;
 b=QftbsT/4ePd/MOqagsRAJJ8KYulwfoMEho9e3V9yFZmaiNazBkg1pDuE
 Se8hJogI4fvHkyzpNaJ+ttUWRC92PW3CxdYO8ISMGu/WLtOrFKv+S7d/T
 G/6jYCYs70decsYhSkyj8Ndv0EqLXC/nQVHQPO1yn2ucuL2FE3WEuyUA1
 xv+vK0mzlt2UVo2y4/IUmxrLEEKpi/nk2mGt6Gkh3va9Q6iJOqlPz6UYy
 NROOdOE7MauBxhaV906R70R51vxiaXoKzNV4iClkDqX4b6Kj/6i5wx/oz
 r5bQZCGJ/39KKrGtwmy7LDXS/c8GQg5VMKzwEk/3D7smeKmup4honqXu2 A==;
X-IronPort-AV: E=McAfee;i="6600,9927,10776"; a="370029046"
X-IronPort-AV: E=Sophos;i="6.01,216,1684825200"; d="scan'208";a="370029046"
Received: from orsmga005.jf.intel.com ([10.7.209.41])
 by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
 19 Jul 2023 07:01:53 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=McAfee;i="6600,9927,10776"; a="897926851"
X-IronPort-AV: E=Sophos;i="6.01,216,1684825200"; d="scan'208";a="897926851"
Received: from orsmsx603.amr.corp.intel.com ([10.22.229.16])
 by orsmga005.jf.intel.com with ESMTP; 19 Jul 2023 07:01:53 -0700
Received: from orsmsx610.amr.corp.intel.com (10.22.229.23) by
 ORSMSX603.amr.corp.intel.com (10.22.229.16) with Microsoft SMTP Server
 (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id
 15.1.2507.27; Wed, 19 Jul 2023 07:01:52 -0700
Received: from orsedg603.ED.cps.intel.com (10.7.248.4) by
 orsmsx610.amr.corp.intel.com (10.22.229.23) with Microsoft SMTP Server
 (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id
 15.1.2507.27 via Frontend Transport; Wed, 19 Jul 2023 07:01:52 -0700
Received: from NAM11-BN8-obe.outbound.protection.outlook.com (104.47.58.169)
 by edgegateway.intel.com (134.134.137.100) with Microsoft SMTP Server
 (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
 15.1.2507.27; Wed, 19 Jul 2023 07:01:52 -0700
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;
 b=X7Zfj8elCoavQaEaQQXjdnrMFEtN+bioBxUQlsPoEQ3MxQY++UIRuf6Y+kWzaTOamgkhK8eFXidRp5BPxcfStsAJ3VOKWQnxQLkx3ttinGdcrVtNPgXEb2rdhh5AuwOj1Y6XpczSmQhQ2fO+7jGwwSmZ/LoQdGsNmVy41oadd6gsuzQCAioHsVvCSDtUVrpuoWiVZ1l7A6XKygIAS2FJwG7B4Uf8C/eIklzDRr98BeTgbGrLjLNCJq6NnaWU7cgtrLwgWejZwZ39wXycb3JaVc06C3uueMM/Kgkr4HZLlgJY8RUjUrU0jXgkVCmDa1yh32Awn+iZSd5Li02TjaNpNQ==
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-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1;
 bh=MURCzRjzGOTWpy9ZjXSEL/hFrvgkhOKGIRjlANoGodg=;
 b=RtYrc+8fs3gQ2NvmojqO9AyLbdMSN1cZQ4IdU1fVmSHMYe3GK7BFEC9jJpP9wyFq8s99h8r1dQsMbgY37d7peFxBqDQmEvi8Bq1dYDoLu4AKh2ZikPceNvRBXTgfRrT/hFnl2sPCH+N6UI98URmgEB13RB4Bpui1RR5vnoWx38vLA03QtHa1ymbnzF/yMs8G1K2t0UJInzpg68s07b3Bo43SEft/7IY5ld1va1O2i9bCvttfNuzDMJ/zbTMZRgOJYNl22bcomd0b7hFNpirkAM5RWm8WVqOVYetawQ6sJWjND72gJ0ZcbPtQU35/tMmInrqALq1Qxe6gJgtfxf1tcw==
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
Authentication-Results: dkim=none (message not signed)
 header.d=none;dmarc=none action=none header.from=intel.com;
Received: from DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17)
 by IA1PR11MB6289.namprd11.prod.outlook.com (2603:10b6:208:3e7::9) with
 Microsoft SMTP Server (version=TLS1_2,
 cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6588.31; Wed, 19 Jul
 2023 14:01:50 +0000
Received: from DS0PR11MB7309.namprd11.prod.outlook.com
 ([fe80::44fc:41c5:90da:642]) by DS0PR11MB7309.namprd11.prod.outlook.com
 ([fe80::44fc:41c5:90da:642%4]) with mapi id 15.20.6588.031; Wed, 19 Jul 2023
 14:01:50 +0000
Date: Wed, 19 Jul 2023 15:01:43 +0100
From: Bruce Richardson <bruce.richardson@intel.com>
To: Stephen Hemminger <stephen@networkplumber.org>
CC: <dev@dpdk.org>, <david.marchand@redhat.com>
Subject: Re: [PATCH v3 0/2] Improve docs on getting info on running process
Message-ID: <ZLfsx2en7o6+Rl5V@bricha3-MOBL.ger.corp.intel.com>
References: <20230613143355.77914-1-bruce.richardson@intel.com>
 <20230718164802.110560-1-bruce.richardson@intel.com>
 <20230718104020.40c2d646@hermes.local>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <20230718104020.40c2d646@hermes.local>
X-ClientProxiedBy: DU2P250CA0029.EURP250.PROD.OUTLOOK.COM
 (2603:10a6:10:231::34) To DS0PR11MB7309.namprd11.prod.outlook.com
 (2603:10b6:8:13e::17)
MIME-Version: 1.0
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|IA1PR11MB6289:EE_
X-MS-Office365-Filtering-Correlation-Id: 4656b61e-257a-4e58-c994-08db8860b2bd
X-MS-Exchange-SenderADCheck: 1
X-MS-Exchange-AntiSpam-Relay: 0
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info: ex0prrFZ4c0XQWsOgdE6bsbeLwL6qxx4fUPC9a9LYzggKZXV/cOXrKcfYAfvpoBalQK3nwTTDgZgSmC7AwcKCB90x6jv2Lf/nZCuM5Xeiuzm7NNmJ7n1xWcBnQhL8V3NwZtLcg/fYE0Yl2X6mLGV/aA9Fdwo/GAP9AeQXd9Zq3kkjCGmUrxUFeBh2s+rBiwxwE1RG/q5cngytdwQ60HSq9/CTUW490wqs50Qqlt0u4m5JibGDQnFwYjuXUTw09rLz0EoqR+QSo9lRZ0JjNYx4oEOlabz6VUo//Io/v75INK1uhJtBifYB0qe24BAL/h3ctQnHoVcIyNYYt+rk9AIGGlob4SMxYIerMUdmLhoD4hxNbdVMECL8E416+Nyb5ZbGl70stMtkfguriX0n0YjTZykq9ddqwj56qHsvIUFSqaMClMJtHoaq1pkh0IWGQpJNeoCtWcK6mJGaNVPu8tYO9/3ohY1VHTVHXDH1sLYhieRy0wplFdRGzXoKgfBAC6oz7c2HWZHPu6gjjhhPvDMbI7mE6Da2a6DfPu9CbeC2pxruFONJMjE9AD9QzeJCgwEzrpQHRjJDwDoX1nNWvUzTMhct1zYfgEMxerL+DNA29o=
X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:;
 IPV:NLI; SFV:NSPM; H:DS0PR11MB7309.namprd11.prod.outlook.com; PTR:; CAT:NONE;
 SFS:(13230028)(39860400002)(366004)(346002)(396003)(136003)(376002)(451199021)(26005)(316002)(41300700001)(6506007)(6512007)(186003)(6486002)(82960400001)(478600001)(6666004)(4326008)(6916009)(66476007)(44832011)(66946007)(66556008)(38100700002)(86362001)(8676002)(2906002)(8936002)(5660300002)(67856001);
 DIR:OUT; SFP:1102; 
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?qmisjkD7n3sy01szeFkrYE6Ns0YAYg+E4Rstwxf98qVLNyZI/THd5EX0gUlt?=
 =?us-ascii?Q?bWbjRwgUtO6YABKrge5qOG1iDaQVzW+hTEhzrAi6PEBQYzDwAHGRSC6kGh4w?=
 =?us-ascii?Q?pvEfS5YCOvdFRLCj2cQmHKP2hcGEG0+fw7Y2RE3iBaK3i5yqoXR2r/zZdHpt?=
 =?us-ascii?Q?1+gw+U7CePHWSVX9zXX+sQ/lKknTkZ9vTKIzLFairnXugSr9VdXooAwQXMXG?=
 =?us-ascii?Q?T85AffN0bZ3EPDDqQdsfAkDnGWAZiEfIaaz1r/FD9Vy3xQ1C1eyYcY+lVveN?=
 =?us-ascii?Q?CZcsnHzYXUpI47W4jGeAsPBZKoX9lYnBU2pHcHbd9pWnvxfInRbvCYZPVaRn?=
 =?us-ascii?Q?k66clEHkySVH+zBbml2P+nqBJ0M5bJIhn3chBXFK++nWXH7gAWRLCf/AM3Qw?=
 =?us-ascii?Q?VILpYobGjP+CtkT/WtrSlCuaNLh3JGrCtQnNg5wNU5wnLN2qp0d7/gMvpTKw?=
 =?us-ascii?Q?tsS8js+nazetJdmmDji2vBZORgSULAat0bpvIUsbuFkMjFNJVOuVIuFTVtfR?=
 =?us-ascii?Q?/B8ODl/TJCPFYsbJCWv3E/3JCQBuljj/l9BbG74jxfLDdFcAA4mThqybLNUD?=
 =?us-ascii?Q?oqZ5wf6HhSVjWuNz8ym/rDvHPr8/XGhubi5+aWxLW2OYVBZvwTfenQJuLy2u?=
 =?us-ascii?Q?dpNdhLYmIip2BWl9T7eqja61q8mP5VAJYfL4tdVu9xWmR4RxajXywxQpZuBc?=
 =?us-ascii?Q?D0P2A9bjE2988fs2PGtfMP76ccJP7iDWWf1W/nG8ELs1P0JZj5nTH+JBTmq2?=
 =?us-ascii?Q?cAaF/bSzbKqsIL513ZXN/7h9k4muPAhpzTrsY2Hj776Ampl2xObkNuHBEtTX?=
 =?us-ascii?Q?Xt91WGp9y6M8VWu0pGAhO9uH/vytTyCMUa3SY4Nxqw720v1OApEnRGRL7AQr?=
 =?us-ascii?Q?ZtW1WbpElayUfKkcgDV865AyB3VXbcCZ9qAd3JdsC87scF/qFWQSJ7g3zieT?=
 =?us-ascii?Q?H7i0M0axYI1Zw+c3K/+mzqFxDRT2DpZrnhEe7L0Kz915AwyqKUuh4DxDuCrH?=
 =?us-ascii?Q?cFMfghx8OvC5WVnIcDGrNkAdjKjJPMirXczlFvVmpOEUsAn6U5mbpafqxRqo?=
 =?us-ascii?Q?g/ERvMejJVnnHqLE6CqjuLalxH4LVH8qn2FfTPXLUleGEmabOS/ftWpZb96O?=
 =?us-ascii?Q?pdxiLoaX7oSl+7TYrzO2ixryy5tWW/q/VgCskbs5vYFFYbqTEMPmVjR2HoMo?=
 =?us-ascii?Q?/u8ve6LsJvPEscecx+JuxM6s3Z3c+1eUQfniJowtXOXMNAKsOAwWkGRGfMRc?=
 =?us-ascii?Q?INcIKhAP9D6Zf4oRNu91aQa+VEcu8URLr68Yos0Tk4V0VhjK6uIDwFo0EsSf?=
 =?us-ascii?Q?k1M+pKu0ixAEE+ztfalxQvPewHYY+MG64M7yEayNzLO+rX6OOphHwsK3vTeB?=
 =?us-ascii?Q?60xPLKytJACfLAqKSCClVjLlJH3Q/r243/SkUoafn0Ns/TIP0g9dY/5EqjQE?=
 =?us-ascii?Q?Jp6rf5UJM6YpcF3fcK664wJiRSo512acB0u1czMH2n4fRAAmqnfQEdLdWEUn?=
 =?us-ascii?Q?JCDUR0TlcTZShKgFOWx1nletuB6iZXIYIHKn4gbnpK8ymMpEBS3F7/RrPgY6?=
 =?us-ascii?Q?xCkCVnrIelf8mOhi+qrI2R9FbGROulcgy27Hf0lRbEYv0pnI8X3j7bz+0HZM?=
 =?us-ascii?Q?gA=3D=3D?=
X-MS-Exchange-CrossTenant-Network-Message-Id: 4656b61e-257a-4e58-c994-08db8860b2bd
X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jul 2023 14:01:50.2526 (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: kkYNSSSgwRI7wJsbIKWAV8fwwBczTQ9hQViExAndzvo7mXcyRfkaU8DcxJ11DvqMhZk7RI9wsM7c+oy52cuMVO8t/0Gzfysw4uajBboUyiI=
X-MS-Exchange-Transport-CrossTenantHeadersStamped: IA1PR11MB6289
X-OriginatorOrg: intel.com
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org

On Tue, Jul 18, 2023 at 10:40:20AM -0700, Stephen Hemminger wrote:
> On Tue, 18 Jul 2023 17:48:00 +0100
> Bruce Richardson <bruce.richardson@intel.com> wrote:
> 
> > Add details to our documentation on how to register logging for a
> > component. Also provide guidelines on when to use logs vs tracing
> > vs telemetry.
> > 
> > V3: Moved new doc section on runtime info, and other minor changes flagged
> >     by David on review.
> > 
> > V2: extended second patch based on the feedback provided.
> >     Hopefully, we can keep this section short and clear as the
> >     revisions roll! :-)
> > 
> > Bruce Richardson (2):
> >   doc/contributing: provide coding details for dynamic logging
> >   doc/contributing: guidelines for logging, tracing and telemetry
> > 
> >  doc/guides/contributing/coding_style.rst | 18 +++++++++
> >  doc/guides/contributing/design.rst       | 49 ++++++++++++++++++++++++
> >  doc/guides/prog_guide/telemetry_lib.rst  |  2 +
> >  doc/guides/prog_guide/trace_lib.rst      |  2 +
> >  lib/cfgfile/rte_cfgfile.c                |  2 +
> >  5 files changed, 73 insertions(+)
> > 
> > --
> > 2.39.2
> > 
> 
> Should we add explicit statements about:
>   - Static logtypes (especially LOGTYPE_PMD) should not be used.
>   - New static logtypes must not be added.

How about:

+.. note::
+
+   The statically-defined log types defined in ``rte_log.h`` are for legacy components,
+   and they will likely be removed in a future release.
+   Do not add new entries to this file.
+

Any suggested rewording before I spin a new patch?

/Bruce