| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <36d52843-0070-6f34-bb73-21ecaed776a5@intel.com>
Date: Tue, 18 Jul 2023 13:33:46 +0300
From: Adrian Hunter <adrian.hunter@...el.com>
To: Changbin Du <changbin.du@...wei.com>,
Peter Zijlstra <peterz@...radead.org>,
Ingo Molnar <mingo@...hat.com>,
Arnaldo Carvalho de Melo <acme@...nel.org>
Cc: Mark Rutland <mark.rutland@....com>,
Alexander Shishkin <alexander.shishkin@...ux.intel.com>,
Jiri Olsa <jolsa@...nel.org>,
Namhyung Kim <namhyung@...nel.org>,
Ian Rogers <irogers@...gle.com>,
Adrian Hunter <adrian.hunter@...el.com>,
linux-perf-users@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] perf: doc: fix format of unordered lists
On 18/07/23 11:52, Changbin Du wrote:
> Fix the format of unordered lists so the can wrap properly.
>
> Signed-off-by: Changbin Du <changbin.du@...wei.com>
Acked-by: Adrian Hunter <adrian.hunter@...el.com>
> ---
> tools/perf/Documentation/perf-ftrace.txt | 16 +++---
> tools/perf/Documentation/perf-record.txt | 73 +++++++++++++-----------
> 2 files changed, 48 insertions(+), 41 deletions(-)
>
> diff --git a/tools/perf/Documentation/perf-ftrace.txt b/tools/perf/Documentation/perf-ftrace.txt
> index df4595563801..d780b93fcf87 100644
> --- a/tools/perf/Documentation/perf-ftrace.txt
> +++ b/tools/perf/Documentation/perf-ftrace.txt
> @@ -96,8 +96,9 @@ OPTIONS for 'perf ftrace trace'
>
> --func-opts::
> 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::
> --graph-funcs=::
> @@ -118,11 +119,12 @@ OPTIONS for 'perf ftrace trace'
>
> --graph-opts::
> List of options allowed to set:
> - nosleep-time - Measure on-CPU time only for function_graph tracer.
> - noirqs - Ignore functions that happen inside interrupt.
> - verbose - Show process names, PIDs, timestamps, etc.
> - thresh=<n> - Setup trace duration threshold in microseconds.
> - depth=<n> - Set max depth for function graph tracer to follow.
> +
> + - nosleep-time - Measure on-CPU time only for function_graph tracer.
> + - noirqs - Ignore functions that happen inside interrupt.
> + - verbose - Show process names, PIDs, timestamps, etc.
> + - thresh=<n> - Setup trace duration threshold in microseconds.
> + - depth=<n> - Set max depth for function graph tracer to follow.
>
>
> OPTIONS for 'perf ftrace latency'
> diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt
> index 9c01076f6c89..8ee5d60225ec 100644
> --- a/tools/perf/Documentation/perf-record.txt
> +++ b/tools/perf/Documentation/perf-record.txt
> @@ -523,9 +523,10 @@ CLOCK_BOOTTIME, CLOCK_REALTIME and CLOCK_TAI.
> Select AUX area tracing Snapshot Mode. This option is valid only with an
> AUX area tracing event. Optionally, certain snapshot capturing parameters
> 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;
> - <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
> and on exit if the above 'e' option is given.
> @@ -572,8 +573,9 @@ providing implementation for Posix AIO API.
>
> --affinity=mode::
> 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::
>
> @@ -625,16 +627,17 @@ Record timestamp boundary (time of first/last samples).
> --switch-output[=mode]::
> Generate multiple perf.data files, timestamp prefixed, switching to a new one
> 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
> - 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.
> + - "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
> + 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
> that gets then processed, possibly via a perf script, to decide if that
> @@ -680,11 +683,12 @@ choice in this option. For example, --synth=no would have MMAP events for
> kernel and modules.
>
> Available types are:
> - 'task' - synthesize FORK and COMM events for each task
> - 'mmap' - synthesize MMAP events for each process (implies 'task')
> - 'cgroup' - synthesize CGROUP events for each cgroup
> - 'all' - synthesize all events (default)
> - 'no' - do not synthesize any of the above events
> +
> + - 'task' - synthesize FORK and COMM events for each task
> + - 'mmap' - synthesize MMAP events for each process (implies 'task')
> + - 'cgroup' - synthesize CGROUP events for each cgroup
> + - 'all' - synthesize all events (default)
> + - 'no' - do not synthesize any of the above events
>
> --tail-synthesize::
> Instead of collecting non-sample events (for example, fork, comm, mmap) at
> @@ -736,18 +740,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.
>
> Available commands:
> - 'enable' : enable events
> - 'disable' : disable events
> - 'enable name' : enable event 'name'
> - 'disable name' : disable event 'name'
> - 'snapshot' : AUX area tracing snapshot).
> - 'stop' : stop perf record
> - 'ping' : ping
> -
> - 'evlist [-v|-g|-F] : display all events
> - -F Show just the sample frequency used for each event.
> - -v Show all fields.
> - -g Show event group information.
> +
> + - 'enable' : enable events
> + - 'disable' : disable events
> + - 'enable name' : enable event 'name'
> + - 'disable name' : disable event 'name'
> + - 'snapshot' : AUX area tracing snapshot).
> + - 'stop' : stop perf record
> + - 'ping' : ping
> + - 'evlist [-v|-g|-F] : display all events
> +
> + -F Show just the sample frequency used for each event.
> + -v Show all fields.
> + -g Show event group information.
>
> 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
> @@ -808,10 +813,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
> layout:
>
> - cpu - create new data streaming thread for every monitored cpu
> - core - create new thread to monitor CPUs grouped by a core
> - package - create new thread to monitor CPUs grouped by a package
> - numa - create new threed to monitor CPUs grouped by a NUMA domain
> + - cpu - create new data streaming thread for every monitored cpu
> + - core - create new thread to monitor CPUs grouped by a core
> + - package - create new thread to monitor CPUs grouped by a package
> + - 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
> order not to spawn multiple per-cpu streaming threads but still avoid LOST
Powered by blists - more mailing lists