mirrors
/
linux-stable
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
1
0
Fork 0
Code Issues Releases Wiki Activity

tracing: Fix events.rst section numbering 

The in-kernel trace event API should have its own section, and the
duplicate section numbers need fixing as well.

Reported-by: Li Xinhai <lixinhai.lxh@gmail.com>
Signed-off-by: Tom Zanussi <zanussi@kernel.org>
Acked-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Link: https://lore.kernel.org/r/90ea854dfb728390b50ddf8a8675238973ee014a.camel@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
Tom Zanussi 2020-05-18 13:29:24 -05:00 committed by Jonathan Corbet
parent dd9a41bc61
commit b8170fad6e
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
Documentation/trace/events.rst
View File

@ -527,8 +527,8 @@ The following commands are supported:
See Documentation/trace/histogram.rst for details and examples. 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 In most cases, the command-line interface to trace events is more than
sufficient. Sometimes, however, applications might find the need for sufficient. Sometimes, however, applications might find the need for
@ -560,8 +560,8 @@ following:
- tracing synthetic events from in-kernel code - tracing synthetic events from in-kernel code
- the low-level "dynevent_cmd" API - 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 There are a couple ways to create a new synthetic event from a kernel
module or other kernel code. module or other kernel code.
@ -666,8 +666,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 At this point, the event object is ready to be used for tracing new
events. 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 To trace a synthetic event, there are several options. The first
option is to trace the event in one call, using synth_event_trace() option is to trace the event in one call, using synth_event_trace()
@ -678,8 +678,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 synth_event_add_next_val() or synth_event_add_val() to add the values
piecewise. 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 To trace a synthetic event all at once, the synth_event_trace() or
synth_event_trace_array() functions can be used. synth_event_trace_array() functions can be used.
@ -780,8 +780,8 @@ remove the event::
ret = synth_event_delete("schedtest"); 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 To trace a synthetic using the piecewise method described above, the
synth_event_trace_start() function is used to 'open' the synthetic synth_event_trace_start() function is used to 'open' the synthetic
@ -864,8 +864,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 of whether any of the add calls failed (say due to a bad field name
being passed in). 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 To create a kprobe or kretprobe trace event from kernel code, the
kprobe_event_gen_cmd_start() or kretprobe_event_gen_cmd_start() kprobe_event_gen_cmd_start() or kretprobe_event_gen_cmd_start()
@ -941,8 +941,8 @@ used to give the kprobe event file back and delete the event::
ret = kprobe_event_delete("gen_kprobe_test"); 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 Both the in-kernel synthetic event and kprobe interfaces are built on
top of a lower-level "dynevent_cmd" interface. This interface is top of a lower-level "dynevent_cmd" interface. This interface is