linux/tools/perf/Documentation
Yujie Liu fa9bc517af perf script: Update brstack syntax documentation
The following commits added new fields/flags to the branch stack field
list:

commit 1f48989cdc ("perf script: Output branch sample type")
commit 6ade6c6460 ("perf script: Show branch speculation info")
commit 1e66dcff7b ("perf script: Add not taken event for branch stack")

Update brstack syntax documentation to be consistent with the latest
branch stack field list. Improve the descriptions to help users
interpret the fields accurately.

Signed-off-by: Yujie Liu <yujie.liu@intel.com>
Reviewed-by: Leo Yan <leo.yan@arm.com>
Reviewed-by: Sandipan Das <sandipan.das@amd.com>
Link: https://lore.kernel.org/r/20250312072329.419020-1-yujie.liu@intel.com
Signed-off-by: Namhyung Kim <namhyung@kernel.org>
2025-03-14 10:41:08 -07:00
..
Build.txt perf docs: Document cross compilation 2024-07-26 11:15:55 -07:00
Makefile perf doc: Add support for KBUILD_BUILD_TIMESTAMP 2023-05-15 17:49:01 -03:00
android.txt
arm-coresight.txt perf docs: Fix man page build wrt perf-arm-coresight.txt 2022-10-25 17:40:48 -03:00
asciidoc.conf
asciidoctor-extensions.rb
build-docdep.perl perf doc: Fix doc.dep 2021-08-02 09:56:17 -03:00
build-xed.txt
callchain-overhead-calculation.txt perf report: Add latency and parallelism profiling documentation 2025-02-18 14:04:32 -08:00
cat-texi.perl perf doc: Fix perfman.info build 2021-08-02 09:56:17 -03:00
cpu-and-latency-overheads.txt perf report: Add latency and parallelism profiling documentation 2025-02-18 14:04:32 -08:00
db-export.txt
examples.txt
guest-files.txt perf tools: Tidy guest option documentation 2022-08-11 18:50:17 -03:00
guestmount.txt perf tools: Tidy guest option documentation 2022-08-11 18:50:17 -03:00
intel-bts.txt
intel-hybrid.txt perf tools: Fix up some comments and code to properly use the event_source bus 2025-02-19 13:23:43 -08:00
intel-pt.txt
itrace.txt perf arm-spe: Update --itrace help text 2024-10-29 16:10:17 -07:00
jit-interface.txt
jitdump-specification.txt perf doc: Fix typos all over the place 2021-09-27 09:32:28 -03:00
manpage-1.72.xsl
manpage-base.xsl
manpage-bold-literal.xsl
manpage-normal.xsl
manpage-suppress-sp.xsl
perf-amd-ibs.txt perf doc: Add AMD IBS usage document 2024-06-20 16:51:55 -07:00
perf-annotate.txt perf annotate: Add --code-with-type option. 2025-03-13 00:19:51 -07:00
perf-archive.txt
perf-arm-spe.txt perf docs: arm_spe: Document new discard mode 2025-01-10 14:50:55 +00:00
perf-bench.txt perf bench sched pipe: Add -G/--cgroups option 2023-10-25 10:02:10 -07:00
perf-buildid-cache.txt perf record: Disable debuginfod by default 2022-01-15 17:41:25 -03:00
perf-buildid-list.txt perf buildid-list: Add a "-m" option to show kernel and modules build-ids 2022-07-18 16:35:34 -03:00
perf-c2c.txt perf c2c: Add report option to show false sharing in adjacent cachelines 2023-02-16 09:33:45 -03:00
perf-check.txt perf tools: Remove dependency on libaudit 2025-01-10 10:59:42 -03:00
perf-config.txt perf config: Fix trival typo 'an' -> 'can' 2024-12-09 17:51:53 -03:00
perf-daemon.txt
perf-data.txt
perf-diff.txt perf tools: Make quiet mode consistent between tools 2022-10-27 16:37:26 -03:00
perf-dlfilter.txt perf dlfilter: Add al_cleanup() 2023-08-15 16:41:49 -03:00
perf-evlist.txt
perf-ftrace.txt perf ftrace profile: Add --graph-opts option 2025-01-08 17:20:42 -03:00
perf-help.txt
perf-inject.txt perf inject: Clarify build-id options a little bit 2022-10-04 08:55:22 -03:00
perf-intel-pt.txt perf intel-pt: Add documentation for pause / resume 2024-12-18 16:24:32 -03:00
perf-iostat.txt perf docs: Fix accidental em-dashes 2021-08-10 11:05:21 -03:00
perf-kallsyms.txt
perf-kmem.txt perf kmem: Improve man page for record options 2021-10-08 16:10:02 -03:00
perf-kvm.txt perf docs: Refine the description for the buffer size 2024-08-12 13:59:22 -03:00
perf-kwork.txt perf docs: Fix typos 2024-05-28 22:52:28 -07:00
perf-list.txt perf list: Document -v option deduplication feature 2025-02-26 16:23:47 -08:00
perf-lock.txt perf lock: Report owner stack in usermode 2025-02-28 10:09:02 -08:00
perf-mem.txt perf mem: Update documentation for new options 2024-08-05 11:40:20 -03:00
perf-probe.txt perf docs: Fix a typo in 'perf probe' man page: l20th -> 120th 2023-01-19 09:49:59 -03:00
perf-record.txt perf report: Add --latency flag 2025-02-18 14:04:32 -08:00
perf-report.txt perf report: Add latency and parallelism profiling documentation 2025-02-18 14:04:32 -08:00
perf-sched.txt perf sched timehist: Add pre-migration wait time option 2024-10-14 12:04:31 -07:00
perf-script-perl.txt perf tools docs: Use canonical ftrace path 2023-02-02 16:32:19 -03:00
perf-script-python.txt perf scripting python: Add function to get a config value 2024-09-24 11:47:03 -07:00
perf-script.txt perf script: Update brstack syntax documentation 2025-03-14 10:41:08 -07:00
perf-stat.txt perf stat: Add command line option for enabling TPEBS recording 2024-08-13 15:25:32 -03:00
perf-test.txt perf test: Improve verbose documentation 2025-01-16 11:01:03 -08:00
perf-timechart.txt
perf-top.txt perf docs: Refine the description for the buffer size 2024-08-12 13:59:22 -03:00
perf-trace.txt perf trace: Add --summary-mode option 2025-02-12 19:44:16 -08:00
perf-version.txt
perf.data-directory-format.txt
perf.data-file-format.txt perf doc: Fix typo in perf.data-file-format.txt 2023-07-28 19:01:16 -03:00
perf.txt perf doc: Add AMD IBS usage document 2024-06-20 16:51:55 -07:00
perfconfig.example
security.txt
tips.txt perf report: Add latency and parallelism profiling documentation 2025-02-18 14:04:32 -08:00
topdown.txt perf Document: Add TPEBS (Timed PEBS(Precise Event-Based Sampling)) to Documents 2024-08-13 15:25:33 -03:00