From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.2 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_PATCH,MAILING_LIST_MULTI,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_SANE_2 autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 43549C433E0 for ; Fri, 22 May 2020 12:37:45 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 213A3206D5 for ; Fri, 22 May 2020 12:37:45 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1728853AbgEVMho (ORCPT ); Fri, 22 May 2020 08:37:44 -0400 Received: from mail.kernel.org ([198.145.29.99]:35822 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728717AbgEVMho (ORCPT ); Fri, 22 May 2020 08:37:44 -0400 Received: from gandalf.local.home (cpe-66-24-58-225.stny.res.rr.com [66.24.58.225]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 3B400206D5; Fri, 22 May 2020 12:37:43 +0000 (UTC) Date: Fri, 22 May 2020 08:37:41 -0400 From: Steven Rostedt To: Tom Zanussi Cc: lixinhai.lxh@gmail.com, linux-kernel , Jonathan Corbet , linux-doc@vger.kernel.org Subject: Re: [PATCH] tracing: Fix events.rst section numbering Message-ID: <20200522083741.7d489e91@gandalf.local.home> In-Reply-To: <90ea854dfb728390b50ddf8a8675238973ee014a.camel@kernel.org> References: <90ea854dfb728390b50ddf8a8675238973ee014a.camel@kernel.org> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-pc-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Mon, 18 May 2020 13:29:24 -0500 Tom Zanussi wrote: > The in-kernel trace event API should have its own section, and the > duplicate section numbers need fixing as well. > > Signed-off-by: Tom Zanussi Acked-by: Steven Rostedt (VMware) Jon, Care to take this in your tree? -- Steve > Reported-by: Li Xinhai > --- > Documentation/trace/events.rst | 28 ++++++++++++++-------------- > 1 file changed, 14 insertions(+), 14 deletions(-) > > diff --git a/Documentation/trace/events.rst b/Documentation/trace/events.rst > index ed79b220bd07..1a3b7762cb0f 100644 > --- a/Documentation/trace/events.rst > +++ b/Documentation/trace/events.rst > @@ -526,8 +526,8 @@ The following commands are supported: > > See Documentation/trace/histogram.rst for details and examples. > > -6.3 In-kernel trace event API > ------------------------------ > +7. In-kernel trace event API > +============================ > > In most cases, the command-line interface to trace events is more than > sufficient. Sometimes, however, applications might find the need for > @@ -559,8 +559,8 @@ following: > - tracing synthetic events from in-kernel code > - the low-level "dynevent_cmd" API > > -6.3.1 Dyamically creating synthetic event definitions > ------------------------------------------------------ > +7.1 Dyamically creating synthetic event definitions > +--------------------------------------------------- > > There are a couple ways to create a new synthetic event from a kernel > module or other kernel code. > @@ -665,8 +665,8 @@ registered by calling the synth_event_gen_cmd_end() function: > At this point, the event object is ready to be used for tracing new > events. > > -6.3.3 Tracing synthetic events from in-kernel code > --------------------------------------------------- > +7.2 Tracing synthetic events from in-kernel code > +------------------------------------------------ > > To trace a synthetic event, there are several options. The first > option is to trace the event in one call, using synth_event_trace() > @@ -677,8 +677,8 @@ synth_event_trace_start() and synth_event_trace_end() along with > synth_event_add_next_val() or synth_event_add_val() to add the values > piecewise. > > -6.3.3.1 Tracing a synthetic event all at once > ---------------------------------------------- > +7.2.1 Tracing a synthetic event all at once > +------------------------------------------- > > To trace a synthetic event all at once, the synth_event_trace() or > synth_event_trace_array() functions can be used. > @@ -779,8 +779,8 @@ remove the event: > > ret = synth_event_delete("schedtest"); > > -6.3.3.1 Tracing a synthetic event piecewise > -------------------------------------------- > +7.2.2 Tracing a synthetic event piecewise > +----------------------------------------- > > To trace a synthetic using the piecewise method described above, the > synth_event_trace_start() function is used to 'open' the synthetic > @@ -863,8 +863,8 @@ Note that synth_event_trace_end() must be called at the end regardless > of whether any of the add calls failed (say due to a bad field name > being passed in). > > -6.3.4 Dyamically creating kprobe and kretprobe event definitions > ----------------------------------------------------------------- > +7.3 Dyamically creating kprobe and kretprobe event definitions > +-------------------------------------------------------------- > > To create a kprobe or kretprobe trace event from kernel code, the > kprobe_event_gen_cmd_start() or kretprobe_event_gen_cmd_start() > @@ -940,8 +940,8 @@ used to give the kprobe event file back and delete the event: > > ret = kprobe_event_delete("gen_kprobe_test"); > > -6.3.4 The "dynevent_cmd" low-level API > --------------------------------------- > +7.4 The "dynevent_cmd" low-level API > +------------------------------------ > > Both the in-kernel synthetic event and kprobe interfaces are built on > top of a lower-level "dynevent_cmd" interface. This interface is