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
Date: Wed, 19 Jul 2023 09:32:36 +0100 [thread overview]
Message-ID: <ZLefpPkFmZhMLoqO@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <20230718104020.40c2d646@hermes.local>
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.
I would hope that should not be necessary especially since this section
talks about dynamic logging only. However, no harm in adding a
one-line note about it. I'll see if I can get a few minutes to spin a V4
with an extra note, but if not I think this set is good to go as-is.
/Bruce
next prev parent reply other threads:[~2023-07-19 8:32 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-13 14:33 [PATCH " Bruce Richardson
2023-06-13 14:33 ` [PATCH 1/2] doc/contributing: provide coding details for dynamic logging Bruce Richardson
2023-06-13 14:33 ` [PATCH 2/2] doc/contributing: guidelines for logging, tracing and telemetry Bruce Richardson
2023-06-13 15:21 ` Stephen Hemminger
2023-06-13 19:38 ` Morten Brørup
2023-06-14 8:36 ` Bruce Richardson
2023-06-14 9:39 ` Morten Brørup
2023-06-14 11:35 ` Ferruh Yigit
2023-06-15 11:51 ` Jerin Jacob
2023-06-20 17:07 ` [PATCH v2 0/2] Improve docs on getting info on running process Bruce Richardson
2023-06-20 17:07 ` [PATCH v2 1/2] doc/contributing: provide coding details for dynamic logging Bruce Richardson
2023-07-04 6:20 ` fengchengwen
2023-07-04 7:46 ` David Marchand
2023-06-20 17:07 ` [PATCH v2 2/2] doc/contributing: guidelines for logging, tracing and telemetry Bruce Richardson
2023-07-04 7:54 ` David Marchand
2023-07-18 16:48 ` [PATCH v3 0/2] Improve docs on getting info on running process Bruce Richardson
2023-07-18 16:48 ` [PATCH v3 1/2] doc/contributing: provide coding details for dynamic logging Bruce Richardson
2023-07-18 20:23 ` Ferruh Yigit
2023-07-18 16:48 ` [PATCH v3 2/2] doc/contributing: guidelines for logging, tracing and telemetry Bruce Richardson
2023-07-18 20:23 ` Ferruh Yigit
2023-07-19 1:07 ` lihuisong (C)
2023-07-20 10:57 ` Jerin Jacob
2023-07-18 17:40 ` [PATCH v3 0/2] Improve docs on getting info on running process Stephen Hemminger
2023-07-19 8:32 ` Bruce Richardson [this message]
2023-07-19 14:01 ` Bruce Richardson
2023-07-20 11:05 ` [PATCH v4 " Bruce Richardson
2023-07-20 11:05 ` [PATCH v4 1/2] doc/contributing: provide coding details for dynamic logging Bruce Richardson
2023-07-20 11:05 ` [PATCH v4 2/2] doc/contributing: guidelines for logging, tracing and telemetry Bruce Richardson
2023-07-25 9:51 ` Thomas Monjalon
2023-07-20 12:38 ` [PATCH v4 0/2] Improve docs on getting info on running process Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ZLefpPkFmZhMLoqO@bricha3-MOBL.ger.corp.intel.com \
--to=bruce.richardson@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=stephen@networkplumber.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).