[v4,0/2] Improve docs on getting info on running process
| Message ID | 20230720110540.231342-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 6C89042EC5; Thu, 20 Jul 2023 13:05:49 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E5C4140E2D; Thu, 20 Jul 2023 13:05:48 +0200 (CEST) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id E0D3E40DF5 for <dev@dpdk.org>; Thu, 20 Jul 2023 13:05:46 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1689851147; x=1721387147; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=heeuAV5mD2Y1pr7htMa+FyfoI2AWVRtXk314WZHsSJw=; b=HODeBnaQqoUwIaQi13lzsOZftO5XqRbeclSPvqThve7xAoCrNJjcGkqJ BGI00LLbW16GdD8r7BBczqbsgCfwvx/cPyhCHVKGKNUcUMJXcelTchcbW 2EkxgnZZENKFt8vOisUIZDP5YyY3HdHvrBaJy1lt8+F31DAwBYm3Ll0a0 Pg335Hylc4tOw4y/q1mK7oRX9CeK6j8VU7Q3HjbJA1dPGE5pClS0dDumv yncVBleggDmJcdRrb5+F7NZpxAabvmWdwUppQNvzTw3SvcEAZDHFfnJ8+ IgyNvIQD0Cjr7W2PUD8p2hT55koz7ILmEvnSDF5iwktIseMoVWwojAiNa Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10776"; a="366731403" X-IronPort-AV: E=Sophos;i="6.01,218,1684825200"; d="scan'208";a="366731403" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Jul 2023 04:05:45 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10776"; a="674650211" X-IronPort-AV: E=Sophos;i="6.01,218,1684825200"; d="scan'208";a="674650211" Received: from silpixa00401385.ir.intel.com ([10.237.214.156]) by orsmga003.jf.intel.com with ESMTP; 20 Jul 2023 04:05:44 -0700 From: Bruce Richardson <bruce.richardson@intel.com> To: dev@dpdk.org Cc: Bruce Richardson <bruce.richardson@intel.com> Subject: [PATCH v4 0/2] Improve docs on getting info on running process Date: Thu, 20 Jul 2023 12:05:38 +0100 Message-Id: <20230720110540.231342-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
July 20, 2023, 11:05 a.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.
V4: Added note to patch 1 saying not to use the old static logging method
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.
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 | 24 ++++++++++++
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, 79 insertions(+)
--
2.39.2