Skip to content

Commit b8170fa

Browse files
Tom ZanussiJonathan Corbet
authored andcommitted
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 <[email protected]> Signed-off-by: Tom Zanussi <[email protected]> Acked-by: Steven Rostedt (VMware) <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent dd9a41b commit b8170fa

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

Documentation/trace/events.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -527,8 +527,8 @@ The following commands are supported:
527527

528528
See Documentation/trace/histogram.rst for details and examples.
529529

530-
6.3 In-kernel trace event API
531-
-----------------------------
530+
7. In-kernel trace event API
531+
============================
532532

533533
In most cases, the command-line interface to trace events is more than
534534
sufficient. Sometimes, however, applications might find the need for
@@ -560,8 +560,8 @@ following:
560560
- tracing synthetic events from in-kernel code
561561
- the low-level "dynevent_cmd" API
562562

563-
6.3.1 Dyamically creating synthetic event definitions
564-
-----------------------------------------------------
563+
7.1 Dyamically creating synthetic event definitions
564+
---------------------------------------------------
565565

566566
There are a couple ways to create a new synthetic event from a kernel
567567
module or other kernel code.
@@ -666,8 +666,8 @@ registered by calling the synth_event_gen_cmd_end() function::
666666
At this point, the event object is ready to be used for tracing new
667667
events.
668668

669-
6.3.3 Tracing synthetic events from in-kernel code
670-
--------------------------------------------------
669+
7.2 Tracing synthetic events from in-kernel code
670+
------------------------------------------------
671671

672672
To trace a synthetic event, there are several options. The first
673673
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
678678
synth_event_add_next_val() or synth_event_add_val() to add the values
679679
piecewise.
680680

681-
6.3.3.1 Tracing a synthetic event all at once
682-
---------------------------------------------
681+
7.2.1 Tracing a synthetic event all at once
682+
-------------------------------------------
683683

684684
To trace a synthetic event all at once, the synth_event_trace() or
685685
synth_event_trace_array() functions can be used.
@@ -780,8 +780,8 @@ remove the event::
780780

781781
ret = synth_event_delete("schedtest");
782782

783-
6.3.3.1 Tracing a synthetic event piecewise
784-
-------------------------------------------
783+
7.2.2 Tracing a synthetic event piecewise
784+
-----------------------------------------
785785

786786
To trace a synthetic using the piecewise method described above, the
787787
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
864864
of whether any of the add calls failed (say due to a bad field name
865865
being passed in).
866866

867-
6.3.4 Dyamically creating kprobe and kretprobe event definitions
868-
----------------------------------------------------------------
867+
7.3 Dyamically creating kprobe and kretprobe event definitions
868+
--------------------------------------------------------------
869869

870870
To create a kprobe or kretprobe trace event from kernel code, the
871871
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::
941941

942942
ret = kprobe_event_delete("gen_kprobe_test");
943943

944-
6.3.4 The "dynevent_cmd" low-level API
945-
--------------------------------------
944+
7.4 The "dynevent_cmd" low-level API
945+
------------------------------------
946946

947947
Both the in-kernel synthetic event and kprobe interfaces are built on
948948
top of a lower-level "dynevent_cmd" interface. This interface is

0 commit comments

Comments
 (0)