[v2,0/2] Improve docs on getting info on running process
| Message ID | 20230620170728.74117-1-bruce.richardson@intel.com (mailing list archive) |
|---|---|
| Headers |
Return-Path: <dev-bounces@dpdk.org> X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id DA45742D0A; Tue, 20 Jun 2023 19:07:57 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 5A601410F6; Tue, 20 Jun 2023 19:07:57 +0200 (CEST) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id 8FC98410D7 for <dev@dpdk.org>; Tue, 20 Jun 2023 19:07:55 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1687280875; x=1718816875; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=K9B97o50XF53nUgrtrKMUNhCL5TtKOJpnBOUTmb2SPA=; b=d1DCJd7ottYF5IFqX76DY2TQ7zi7zp2IpQ2syQZLtNVyOFHI4+RXef2X Bq8y8tZ5CNmvpH+F6+VEsA/XOlSDK+bXD4E5pLAsxwqsdZLl6L3eO4xD6 u6GA/byHHt9CnPsc4fvabKnGUU0mDdEn5M5KMIu7IEoFdn1A+rAZB7zH1 tKuaZ0U/gvChTg9DPty1DKK7dn8iTxQyed+OM886gQQszi9y/T0i8JA6x etNQlWW7gbkKM6IlNmtRcklpKVEkZ8jXqk6jrgOGkBniXk7zlP2LlK0Vw Bxl2eQBAutwJseyXr6QpQZri2WLryYK7xbnZ0x3z2KQIJbZgzKI/xl5MW w==; X-IronPort-AV: E=McAfee;i="6600,9927,10747"; a="425877745" X-IronPort-AV: E=Sophos;i="6.00,257,1681196400"; d="scan'208";a="425877745" Received: from orsmga006.jf.intel.com ([10.7.209.51]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Jun 2023 10:07:39 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10747"; a="691507531" X-IronPort-AV: E=Sophos;i="6.00,257,1681196400"; d="scan'208";a="691507531" Received: from silpixa00401385.ir.intel.com ([10.237.214.165]) by orsmga006.jf.intel.com with ESMTP; 20 Jun 2023 10:07:38 -0700 From: Bruce Richardson <bruce.richardson@intel.com> To: dev@dpdk.org Cc: stephen@networkplumber.org, mb@smartsharesystems.com, ferruh.yigit@amd.com, jerinjacobk@gmail.com, Bruce Richardson <bruce.richardson@intel.com> Subject: [PATCH v2 0/2] Improve docs on getting info on running process Date: Tue, 20 Jun 2023 18:07:26 +0100 Message-Id: <20230620170728.74117-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 |
Message
Bruce Richardson
June 20, 2023, 5:07 p.m. UTC
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.
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 | 19 ++++++++++
doc/guides/contributing/design.rst | 47 ++++++++++++++++++++++++
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, 72 insertions(+)
--
2.39.2