Merge tag 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dledford/rdma

[cascardo/linux.git] / tools / perf / Documentation / perf-top.txt

diff --git a/tools/perf/Documentation/perf-top.txt b/tools/perf/Documentation/perf-top.txt
index 776aec4..f6a23eb 100644 (file)
--- a/tools/perf/Documentation/perf-top.txt
+++ b/tools/perf/Documentation/perf-top.txt
@@ -208,6 +208,27 @@ Default is to monitor all CPUS.
        This option sets the time out limit. The default value is 500 ms.
 
 
+-b::
+--branch-any::
+       Enable taken branch stack sampling. Any type of taken branch may be sampled.
+       This is a shortcut for --branch-filter any. See --branch-filter for more infos.
+
+-j::
+--branch-filter::
+       Enable taken branch stack sampling. Each sample captures a series of consecutive
+       taken branches. The number of branches captured with each sample depends on the
+       underlying hardware, the type of branches of interest, and the executed code.
+       It is possible to select the types of branches captured by enabling filters.
+       For a full list of modifiers please see the perf record manpage.
+
+       The option requires at least one branch type among any, any_call, any_ret, ind_call, cond.
+       The privilege levels may be omitted, in which case, the privilege levels of the associated
+       event are applied to the branch filter. Both kernel (k) and hypervisor (hv) privilege
+       levels are subject to permissions.  When sampling on multiple events, branch stack sampling
+       is enabled for all the sampling events. The sampled branch type is the same for all events.
+       The various filters must be specified as a comma separated list: --branch-filter any_ret,u,k
+       Note that this feature may not be available on all processors.
+
 INTERACTIVE PROMPTING KEYS
 --------------------------