Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

perf docs: Fix format of unordered lists

Fix the format of unordered lists so the can wrap properly.

Signed-off-by: Changbin Du <changbin.du@huawei.com>
Acked-by: Adrian 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.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

authored by

Changbin Du and committed by
Arnaldo Carvalho de Melo
a1ef3aaf ab374400

+47 -40
+9 -7
tools/perf/Documentation/perf-ftrace.txt
··· 96 96 97 97 --func-opts:: 98 98 List of options allowed to set: 99 - call-graph - Display kernel stack trace for function tracer. 100 - irq-info - Display irq context info for function tracer. 99 + 100 + - call-graph - Display kernel stack trace for function tracer. 101 + - irq-info - Display irq context info for function tracer. 101 102 102 103 -G:: 103 104 --graph-funcs=:: ··· 119 118 120 119 --graph-opts:: 121 120 List of options allowed to set: 122 - nosleep-time - Measure on-CPU time only for function_graph tracer. 123 - noirqs - Ignore functions that happen inside interrupt. 124 - verbose - Show process names, PIDs, timestamps, etc. 125 - thresh=<n> - Setup trace duration threshold in microseconds. 126 - depth=<n> - Set max depth for function graph tracer to follow. 121 + 122 + - nosleep-time - Measure on-CPU time only for function_graph tracer. 123 + - noirqs - Ignore functions that happen inside interrupt. 124 + - verbose - Show process names, PIDs, timestamps, etc. 125 + - thresh=<n> - Setup trace duration threshold in microseconds. 126 + - depth=<n> - Set max depth for function graph tracer to follow. 127 127 128 128 129 129 OPTIONS for 'perf ftrace latency'
+38 -33
tools/perf/Documentation/perf-record.txt
··· 509 509 Select AUX area tracing Snapshot Mode. This option is valid only with an 510 510 AUX area tracing event. Optionally, certain snapshot capturing parameters 511 511 can be specified in a string that follows this option: 512 - 'e': take one last snapshot on exit; guarantees that there is at least one 512 + 513 + - 'e': take one last snapshot on exit; guarantees that there is at least one 513 514 snapshot in the output file; 514 - <size>: if the PMU supports this, specify the desired snapshot size. 515 + - <size>: if the PMU supports this, specify the desired snapshot size. 515 516 516 517 In Snapshot Mode trace data is captured only when signal SIGUSR2 is received 517 518 and on exit if the above 'e' option is given. ··· 551 550 552 551 --affinity=mode:: 553 552 Set affinity mask of trace reading thread according to the policy defined by 'mode' value: 554 - node - thread affinity mask is set to NUMA node cpu mask of the processed mmap buffer 555 - cpu - thread affinity mask is set to cpu of the processed mmap buffer 553 + 554 + - node - thread affinity mask is set to NUMA node cpu mask of the processed mmap buffer 555 + - cpu - thread affinity mask is set to cpu of the processed mmap buffer 556 556 557 557 --mmap-flush=number:: 558 558 ··· 605 603 --switch-output[=mode]:: 606 604 Generate multiple perf.data files, timestamp prefixed, switching to a new one 607 605 based on 'mode' value: 608 - "signal" - when receiving a SIGUSR2 (default value) or 609 - <size> - when reaching the size threshold, size is expected to 610 - be a number with appended unit character - B/K/M/G 611 - <time> - when reaching the time threshold, size is expected to 612 - be a number with appended unit character - s/m/h/d 613 606 614 - Note: the precision of the size threshold hugely depends 615 - on your configuration - the number and size of your ring 616 - buffers (-m). It is generally more precise for higher sizes 617 - (like >5M), for lower values expect different sizes. 607 + - "signal" - when receiving a SIGUSR2 (default value) or 608 + - <size> - when reaching the size threshold, size is expected to 609 + be a number with appended unit character - B/K/M/G 610 + - <time> - when reaching the time threshold, size is expected to 611 + be a number with appended unit character - s/m/h/d 612 + 613 + Note: the precision of the size threshold hugely depends 614 + on your configuration - the number and size of your ring 615 + buffers (-m). It is generally more precise for higher sizes 616 + (like >5M), for lower values expect different sizes. 618 617 619 618 A possible use case is to, given an external event, slice the perf.data file 620 619 that gets then processed, possibly via a perf script, to decide if that ··· 661 658 kernel and modules. 662 659 663 660 Available types are: 664 - 'task' - synthesize FORK and COMM events for each task 665 - 'mmap' - synthesize MMAP events for each process (implies 'task') 666 - 'cgroup' - synthesize CGROUP events for each cgroup 667 - 'all' - synthesize all events (default) 668 - 'no' - do not synthesize any of the above events 661 + 662 + - 'task' - synthesize FORK and COMM events for each task 663 + - 'mmap' - synthesize MMAP events for each process (implies 'task') 664 + - 'cgroup' - synthesize CGROUP events for each cgroup 665 + - 'all' - synthesize all events (default) 666 + - 'no' - do not synthesize any of the above events 669 667 670 668 --tail-synthesize:: 671 669 Instead of collecting non-sample events (for example, fork, comm, mmap) at ··· 718 714 Listen on ctl-fd descriptor for command to control measurement. 719 715 720 716 Available commands: 721 - 'enable' : enable events 722 - 'disable' : disable events 723 - 'enable name' : enable event 'name' 724 - 'disable name' : disable event 'name' 725 - 'snapshot' : AUX area tracing snapshot). 726 - 'stop' : stop perf record 727 - 'ping' : ping 728 717 729 - 'evlist [-v|-g|-F] : display all events 730 - -F Show just the sample frequency used for each event. 731 - -v Show all fields. 732 - -g Show event group information. 718 + - 'enable' : enable events 719 + - 'disable' : disable events 720 + - 'enable name' : enable event 'name' 721 + - 'disable name' : disable event 'name' 722 + - 'snapshot' : AUX area tracing snapshot). 723 + - 'stop' : stop perf record 724 + - 'ping' : ping 725 + - 'evlist [-v|-g|-F] : display all events 726 + 727 + -F Show just the sample frequency used for each event. 728 + -v Show all fields. 729 + -g Show event group information. 733 730 734 731 Measurements can be started with events disabled using --delay=-1 option. Optionally 735 732 send control command completion ('ack\n') to ack-fd descriptor to synchronize with the ··· 791 786 <spec> value can also be a string meaning predefined parallel threads 792 787 layout: 793 788 794 - cpu - create new data streaming thread for every monitored cpu 795 - core - create new thread to monitor CPUs grouped by a core 796 - package - create new thread to monitor CPUs grouped by a package 797 - numa - create new threed to monitor CPUs grouped by a NUMA domain 789 + - cpu - create new data streaming thread for every monitored cpu 790 + - core - create new thread to monitor CPUs grouped by a core 791 + - package - create new thread to monitor CPUs grouped by a package 792 + - numa - create new threed to monitor CPUs grouped by a NUMA domain 798 793 799 794 Predefined layouts can be used on systems with large number of CPUs in 800 795 order not to spawn multiple per-cpu streaming threads but still avoid LOST