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 3899E42EAA;
Tue, 18 Jul 2023 18:48:14 +0200 (CEST)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id BBDAE42D17;
Tue, 18 Jul 2023 18:48:13 +0200 (CEST)
Received: from mga12.intel.com (mga12.intel.com [192.55.52.136])
by mails.dpdk.org (Postfix) with ESMTP id 26773410D3
for <dev@dpdk.org>; Tue, 18 Jul 2023 18:48:11 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
t=1689698892; x=1721234892;
h=from:to:cc:subject:date:message-id:in-reply-to:
references:mime-version:content-transfer-encoding;
bh=b6nZ6UVHTZRTRjHKG5VInyVh/HQlgSQkf6WtmDbXCfY=;
b=KBcseVCAxV92XO0pxZmk8+fYXGuN6OUH0Vtq4VEGgSkDOg784SumV0m9
18Q/G/LV/ShKRPCRYLnsl6uScTE+wbkWfxoFX9Edn+AY/7rBQKEl7T0gb
nlbyVujvj5WpJU0iPLsFHh9GzFyXJXPtGFBPj1mavUusWH2HFHVVsCAvR
ETb+aVeRbvXGmwxV9WpPnHxJhXMXzkLnA4DPR/G3bK/PVpCpKElAGKchS
BOJDl+WuIEw+bj/ofzNdXdciCVsXxcfpUgfV0Zt7gtB+MczRzKtiAFvt6
m1E7PLOvCgo9Jd5ndG3FZkNUBshx5xLJuBHMp7hfrkZtkFwcHtIbkkKUk Q==;
X-IronPort-AV: E=McAfee;i="6600,9927,10775"; a="345848515"
X-IronPort-AV: E=Sophos;i="6.01,214,1684825200"; d="scan'208";a="345848515"
Received: from fmsmga005.fm.intel.com ([10.253.24.32])
by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
18 Jul 2023 09:48:09 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=McAfee;i="6600,9927,10775"; a="1054367339"
X-IronPort-AV: E=Sophos;i="6.01,214,1684825200"; d="scan'208";a="1054367339"
Received: from unknown (HELO silpixa00401385.ir.intel.com) ([10.237.214.14])
by fmsmga005.fm.intel.com with ESMTP; 18 Jul 2023 09:48:08 -0700
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: david.marchand@redhat.com,
Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH v3 0/2] Improve docs on getting info on running process
Date: Tue, 18 Jul 2023 17:48:00 +0100
Message-Id: <20230718164802.110560-1-bruce.richardson@intel.com>
X-Mailer: git-send-email 2.39.2
In-Reply-To: <20230613143355.77914-1-bruce.richardson@intel.com>
References: <20230613143355.77914-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 <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
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