Linux-Trace-Devel Archive on lore.kernel.org
 help / color / Atom feed
From: Tom Zanussi <zanussi@kernel.org>
To: Steven Rostedt <rostedt@goodmis.org>, 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>
Subject: Re: Documentation/trace/events.rst: wrong numbering of sections
Date: Fri, 15 May 2020 13:22:42 -0500
Message-ID: <2449de9a39bd09510f75bd2358cc7ddfd397e93f.camel@kernel.org> (raw)
In-Reply-To: <20200515091126.75db6ec9@gandalf.local.home>

Hi,

On Fri, 2020-05-15 at 09:11 -0400, Steven Rostedt wrote:
> 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).
> 

Yeah, aside from duplicate numbering in a couple of places, it would
make more sense for everything starting from '6.3 In-kernel trace event
API' to be in a section 7.

Would you like to submit a patch for that, Li, or should I?

Thanks,

Tom

> -- Steve


  reply index

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-15  7:43 Li Xinhai
2020-05-15 13:11 ` Steven Rostedt
2020-05-15 18:22   ` Tom Zanussi [this message]
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=2449de9a39bd09510f75bd2358cc7ddfd397e93f.camel@kernel.org \
    --to=zanussi@kernel.org \
    --cc=corbet@lwn.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-trace-devel@vger.kernel.org \
    --cc=lixinhai.lxh@gmail.com \
    --cc=rostedt@goodmis.org \
    --cc=tytso@mit.edu \
    /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

Linux-Trace-Devel Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-trace-devel/0 linux-trace-devel/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-trace-devel linux-trace-devel/ https://lore.kernel.org/linux-trace-devel \
		linux-trace-devel@vger.kernel.org
	public-inbox-index linux-trace-devel

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-trace-devel


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git