From: Steven Rostedt <rostedt@goodmis.org>
To: "Li Xinhai" <lixinhai.lxh@gmail.com>
Cc: linux-trace-devel <linux-trace-devel@vger.kernel.org>,
linux-kernel <linux-kernel@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>, Theodore Ts'o <tytso@mit.edu>,
Tom Zanussi <zanussi@kernel.org>
Subject: Re: Documentation/trace/events.rst: wrong numbering of sections
Date: Fri, 15 May 2020 09:11:26 -0400 [thread overview]
Message-ID: <20200515091126.75db6ec9@gandalf.local.home> (raw)
In-Reply-To: <2020051515434115672512@gmail.com>
It's best to Cc the maintainers of the file. Nobody reads linux-kernel (it
produces 800 emails a day!). Luckily, I happen to monitor the
linux-trace-devel list (which is mostly for userland tools), otherwise this
email would have been lost to the LKML abyss.
On Fri, 15 May 2020 15:43:43 +0800
"Li Xinhai" <lixinhai.lxh@gmail.com> wrote:
> This document has below numbering of its sections:
>
> 1. Introduction
> 2. Using Event Tracing
> 2.1 Via the 'set_event' interface
> 2.2 Via the 'enable' toggle
> 2.3 Boot option
> 3. Defining an event-enabled tracepoint
> 4. Event formats
> 5. Event filtering
> 5.1 Expression syntax
> 5.2 Setting filters
> 5.3 Clearing filters
> 5.3 Subsystem filters
> 5.4 PID filtering
> 6. Event triggers
> 6.1 Expression syntax
> 6.2 Supported trigger commands
> 6.3 In-kernel trace event API
> 6.3.1 Dyamically creating synthetic event definitions
> 6.3.3 Tracing synthetic events from in-kernel code
> 6.3.3.1 Tracing a synthetic event all at once
> 6.3.3.1 Tracing a synthetic event piecewise
> 6.3.4 Dyamically creating kprobe and kretprobe event definitions
> 6.3.4 The "dynevent_cmd" low-level API
>
> It seems wrong numbering within 6.3 section.
> or, would it be better to have separated chapter #7, for 'In-kernel trace
> event API'? it seems not belong to 'Event triggers'.
Yeah, 6.3.4 (both of them) probably should have been under a new top level
section. (#7).
-- Steve
next prev parent reply other threads:[~2020-05-15 13:11 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-15 7:43 Documentation/trace/events.rst: wrong numbering of sections Li Xinhai
2020-05-15 13:11 ` Steven Rostedt [this message]
2020-05-15 18:22 ` Tom Zanussi
2020-05-18 2:50 ` Li Xinhai
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=20200515091126.75db6ec9@gandalf.local.home \
--to=rostedt@goodmis.org \
--cc=corbet@lwn.net \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-devel@vger.kernel.org \
--cc=lixinhai.lxh@gmail.com \
--cc=tytso@mit.edu \
--cc=zanussi@kernel.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).