Commit a1ef3aaf authored by Changbin Du's avatar Changbin Du Committed by Arnaldo Carvalho de Melo

perf docs: Fix format of unordered lists

Fix the format of unordered lists so the can wrap properly.
Signed-off-by: default avatarChangbin Du <changbin.du@huawei.com>
Acked-by: default avatarAdrian Hunter <adrian.hunter@intel.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Ian Rogers <irogers@google.com>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: https://lore.kernel.org/r/20230718085242.3090797-1-changbin.du@huawei.comSigned-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent ab374400
...@@ -96,8 +96,9 @@ OPTIONS for 'perf ftrace trace' ...@@ -96,8 +96,9 @@ OPTIONS for 'perf ftrace trace'
--func-opts:: --func-opts::
List of options allowed to set: List of options allowed to set:
call-graph - Display kernel stack trace for function tracer.
irq-info - Display irq context info for function tracer. - call-graph - Display kernel stack trace for function tracer.
- irq-info - Display irq context info for function tracer.
-G:: -G::
--graph-funcs=:: --graph-funcs=::
...@@ -118,11 +119,12 @@ OPTIONS for 'perf ftrace trace' ...@@ -118,11 +119,12 @@ OPTIONS for 'perf ftrace trace'
--graph-opts:: --graph-opts::
List of options allowed to set: List of options allowed to set:
nosleep-time - Measure on-CPU time only for function_graph tracer.
noirqs - Ignore functions that happen inside interrupt. - nosleep-time - Measure on-CPU time only for function_graph tracer.
verbose - Show process names, PIDs, timestamps, etc. - noirqs - Ignore functions that happen inside interrupt.
thresh=<n> - Setup trace duration threshold in microseconds. - verbose - Show process names, PIDs, timestamps, etc.
depth=<n> - Set max depth for function graph tracer to follow. - thresh=<n> - Setup trace duration threshold in microseconds.
- depth=<n> - Set max depth for function graph tracer to follow.
OPTIONS for 'perf ftrace latency' OPTIONS for 'perf ftrace latency'
......
...@@ -509,9 +509,10 @@ CLOCK_BOOTTIME, CLOCK_REALTIME and CLOCK_TAI. ...@@ -509,9 +509,10 @@ CLOCK_BOOTTIME, CLOCK_REALTIME and CLOCK_TAI.
Select AUX area tracing Snapshot Mode. This option is valid only with an Select AUX area tracing Snapshot Mode. This option is valid only with an
AUX area tracing event. Optionally, certain snapshot capturing parameters AUX area tracing event. Optionally, certain snapshot capturing parameters
can be specified in a string that follows this option: can be specified in a string that follows this option:
'e': take one last snapshot on exit; guarantees that there is at least one
- 'e': take one last snapshot on exit; guarantees that there is at least one
snapshot in the output file; snapshot in the output file;
<size>: if the PMU supports this, specify the desired snapshot size. - <size>: if the PMU supports this, specify the desired snapshot size.
In Snapshot Mode trace data is captured only when signal SIGUSR2 is received In Snapshot Mode trace data is captured only when signal SIGUSR2 is received
and on exit if the above 'e' option is given. and on exit if the above 'e' option is given.
...@@ -550,8 +551,9 @@ providing implementation for Posix AIO API. ...@@ -550,8 +551,9 @@ providing implementation for Posix AIO API.
--affinity=mode:: --affinity=mode::
Set affinity mask of trace reading thread according to the policy defined by 'mode' value: Set affinity mask of trace reading thread according to the policy defined by 'mode' value:
node - thread affinity mask is set to NUMA node cpu mask of the processed mmap buffer
cpu - thread affinity mask is set to cpu of the processed mmap buffer - node - thread affinity mask is set to NUMA node cpu mask of the processed mmap buffer
- cpu - thread affinity mask is set to cpu of the processed mmap buffer
--mmap-flush=number:: --mmap-flush=number::
...@@ -603,16 +605,17 @@ Record timestamp boundary (time of first/last samples). ...@@ -603,16 +605,17 @@ Record timestamp boundary (time of first/last samples).
--switch-output[=mode]:: --switch-output[=mode]::
Generate multiple perf.data files, timestamp prefixed, switching to a new one Generate multiple perf.data files, timestamp prefixed, switching to a new one
based on 'mode' value: based on 'mode' value:
"signal" - when receiving a SIGUSR2 (default value) or
<size> - when reaching the size threshold, size is expected to
be a number with appended unit character - B/K/M/G
<time> - when reaching the time threshold, size is expected to
be a number with appended unit character - s/m/h/d
Note: the precision of the size threshold hugely depends - "signal" - when receiving a SIGUSR2 (default value) or
on your configuration - the number and size of your ring - <size> - when reaching the size threshold, size is expected to
buffers (-m). It is generally more precise for higher sizes be a number with appended unit character - B/K/M/G
(like >5M), for lower values expect different sizes. - <time> - when reaching the time threshold, size is expected to
be a number with appended unit character - s/m/h/d
Note: the precision of the size threshold hugely depends
on your configuration - the number and size of your ring
buffers (-m). It is generally more precise for higher sizes
(like >5M), for lower values expect different sizes.
A possible use case is to, given an external event, slice the perf.data file A possible use case is to, given an external event, slice the perf.data file
that gets then processed, possibly via a perf script, to decide if that that gets then processed, possibly via a perf script, to decide if that
...@@ -658,11 +661,12 @@ choice in this option. For example, --synth=no would have MMAP events for ...@@ -658,11 +661,12 @@ choice in this option. For example, --synth=no would have MMAP events for
kernel and modules. kernel and modules.
Available types are: Available types are:
'task' - synthesize FORK and COMM events for each task
'mmap' - synthesize MMAP events for each process (implies 'task') - 'task' - synthesize FORK and COMM events for each task
'cgroup' - synthesize CGROUP events for each cgroup - 'mmap' - synthesize MMAP events for each process (implies 'task')
'all' - synthesize all events (default) - 'cgroup' - synthesize CGROUP events for each cgroup
'no' - do not synthesize any of the above events - 'all' - synthesize all events (default)
- 'no' - do not synthesize any of the above events
--tail-synthesize:: --tail-synthesize::
Instead of collecting non-sample events (for example, fork, comm, mmap) at Instead of collecting non-sample events (for example, fork, comm, mmap) at
...@@ -714,18 +718,19 @@ ctl-fifo / ack-fifo are opened and used as ctl-fd / ack-fd as follows. ...@@ -714,18 +718,19 @@ ctl-fifo / ack-fifo are opened and used as ctl-fd / ack-fd as follows.
Listen on ctl-fd descriptor for command to control measurement. Listen on ctl-fd descriptor for command to control measurement.
Available commands: Available commands:
'enable' : enable events
'disable' : disable events - 'enable' : enable events
'enable name' : enable event 'name' - 'disable' : disable events
'disable name' : disable event 'name' - 'enable name' : enable event 'name'
'snapshot' : AUX area tracing snapshot). - 'disable name' : disable event 'name'
'stop' : stop perf record - 'snapshot' : AUX area tracing snapshot).
'ping' : ping - 'stop' : stop perf record
- 'ping' : ping
'evlist [-v|-g|-F] : display all events - 'evlist [-v|-g|-F] : display all events
-F Show just the sample frequency used for each event.
-v Show all fields. -F Show just the sample frequency used for each event.
-g Show event group information. -v Show all fields.
-g Show event group information.
Measurements can be started with events disabled using --delay=-1 option. Optionally Measurements can be started with events disabled using --delay=-1 option. Optionally
send control command completion ('ack\n') to ack-fd descriptor to synchronize with the send control command completion ('ack\n') to ack-fd descriptor to synchronize with the
...@@ -786,10 +791,10 @@ the second monitors CPUs 1 and 5-7 with the affinity mask 5-7. ...@@ -786,10 +791,10 @@ the second monitors CPUs 1 and 5-7 with the affinity mask 5-7.
<spec> value can also be a string meaning predefined parallel threads <spec> value can also be a string meaning predefined parallel threads
layout: layout:
cpu - create new data streaming thread for every monitored cpu - cpu - create new data streaming thread for every monitored cpu
core - create new thread to monitor CPUs grouped by a core - core - create new thread to monitor CPUs grouped by a core
package - create new thread to monitor CPUs grouped by a package - package - create new thread to monitor CPUs grouped by a package
numa - create new threed to monitor CPUs grouped by a NUMA domain - numa - create new threed to monitor CPUs grouped by a NUMA domain
Predefined layouts can be used on systems with large number of CPUs in Predefined layouts can be used on systems with large number of CPUs in
order not to spawn multiple per-cpu streaming threads but still avoid LOST order not to spawn multiple per-cpu streaming threads but still avoid LOST
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment