Skip to content

Commit 348b7ca

Browse files
bagasmeJonathan Corbet
authored andcommitted
Documentation: trace: histogram: Fix histogram trigger subsection number order
Section numbering in subsections of "Histogram Trigger Command" sections is inconsistent in order. In particular, "'hist' trigger examples" is erroneously numbered as 6.2, which is a leftover from b8df4a3 ("tracing: Move hist trigger Documentation to histogram.txt"). Fix the order. Reviewed-by: Tom Zanussi <[email protected]> Reviewed-by: Masami Hiramatsu (Google) <[email protected]> Signed-off-by: Bagas Sanjaya <[email protected]> Acked-by: Steven Rostedt (Google) <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Message-ID: <[email protected]>
1 parent 395107a commit 348b7ca

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

Documentation/trace/histogram.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ Documentation written by Tom Zanussi
186186
The examples below provide a more concrete illustration of the
187187
concepts and typical usage patterns discussed above.
188188

189-
'special' event fields
190-
------------------------
189+
2.1. 'special' event fields
190+
---------------------------
191191

192192
There are a number of 'special event fields' available for use as
193193
keys or values in a hist trigger. These look like and behave as if
@@ -204,16 +204,16 @@ Documentation written by Tom Zanussi
204204
common_cpu int the cpu on which the event occurred.
205205
====================== ==== =======================================
206206

207-
Extended error information
208-
--------------------------
207+
2.2. Extended error information
208+
-------------------------------
209209

210210
For some error conditions encountered when invoking a hist trigger
211211
command, extended error information is available via the
212212
tracing/error_log file. See Error Conditions in
213213
:file:`Documentation/trace/ftrace.rst` for details.
214214

215-
6.2 'hist' trigger examples
216-
---------------------------
215+
2.3. 'hist' trigger examples
216+
----------------------------
217217

218218
The first set of examples creates aggregations using the kmalloc
219219
event. The fields that can be used for the hist trigger are listed
@@ -1608,8 +1608,8 @@ Extended error information
16081608
Entries: 7
16091609
Dropped: 0
16101610

1611-
2.2 Inter-event hist triggers
1612-
-----------------------------
1611+
2.4. Inter-event hist triggers
1612+
------------------------------
16131613

16141614
Inter-event hist triggers are hist triggers that combine values from
16151615
one or more other events and create a histogram using that data. Data
@@ -1685,8 +1685,8 @@ pseudo-file.
16851685

16861686
These features are described in more detail in the following sections.
16871687

1688-
2.2.1 Histogram Variables
1689-
-------------------------
1688+
2.5. Histogram Variables
1689+
------------------------
16901690

16911691
Variables are simply named locations used for saving and retrieving
16921692
values between matching events. A 'matching' event is defined as an
@@ -1789,8 +1789,8 @@ or assigned to a variable and referenced in a subsequent expression::
17891789

17901790
Variables can even hold stacktraces, which are useful with synthetic events.
17911791

1792-
2.2.2 Synthetic Events
1793-
----------------------
1792+
2.6. Synthetic Events
1793+
---------------------
17941794

17951795
Synthetic events are user-defined events generated from hist trigger
17961796
variables or fields associated with one or more other events. Their
@@ -1846,7 +1846,7 @@ the command that defined it with a '!'::
18461846
At this point, there isn't yet an actual 'wakeup_latency' event
18471847
instantiated in the event subsystem - for this to happen, a 'hist
18481848
trigger action' needs to be instantiated and bound to actual fields
1849-
and variables defined on other events (see Section 2.2.3 below on
1849+
and variables defined on other events (see Section 2.7. below on
18501850
how that is done using hist trigger 'onmatch' action). Once that is
18511851
done, the 'wakeup_latency' synthetic event instance is created.
18521852

@@ -2094,8 +2094,8 @@ histogram::
20942094
Entries: 7
20952095
Dropped: 0
20962096

2097-
2.2.3 Hist trigger 'handlers' and 'actions'
2098-
-------------------------------------------
2097+
2.7. Hist trigger 'handlers' and 'actions'
2098+
------------------------------------------
20992099

21002100
A hist trigger 'action' is a function that's executed (in most cases
21012101
conditionally) whenever a histogram entry is added or updated.
@@ -2526,8 +2526,8 @@ The following commonly-used handler.action pairs are available:
25262526
kworker/3:2-135 [003] d..3 49.823123: sched_switch: prev_comm=kworker/3:2 prev_pid=135 prev_prio=120 prev_state=T ==> next_comm=swapper/3 next_pid=0 next_prio=120
25272527
<idle>-0 [004] ..s7 49.823798: tcp_probe: src=10.0.0.10:54326 dest=23.215.104.193:80 mark=0x0 length=32 snd_nxt=0xe3ae2ff5 snd_una=0xe3ae2ecd snd_cwnd=10 ssthresh=2147483647 snd_wnd=28960 srtt=19604 rcv_wnd=29312
25282528

2529-
3. User space creating a trigger
2530-
--------------------------------
2529+
2.8. User space creating a trigger
2530+
----------------------------------
25312531

25322532
Writing into /sys/kernel/tracing/trace_marker writes into the ftrace
25332533
ring buffer. This can also act like an event, by writing into the trigger

0 commit comments

Comments
 (0)