[patch] perf_event_open.2 -- clarify PERF_SAMPLE_STACK_USER usage

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



This clarifies the PERF_SAMPLE_STACK_USER section.  I found these issus
while implementing some code that uses the option.  The important change
is fixing the name of the sample_stack_user parameter, the rest is just
some wording fixes and minor clarifications.

Signed-off-by: Vince Weaver <vincent.weaver@xxxxxxxxx>

diff --git a/man2/perf_event_open.2 b/man2/perf_event_open.2
index 47e9984..4c54b6b 100644
--- a/man2/perf_event_open.2
+++ b/man2/perf_event_open.2
@@ -1885,13 +1885,15 @@ bit mask.
 .IR size ", " data[size] ", " dyn_size
 If
 .B PERF_SAMPLE_STACK_USER
-is enabled, then record the user stack to enable backtracing.
+is enabled, then the user stack is recorded.
+This can be used to generate stack backtraces.
 .I size
 is the size requested by the user in
-.I stack_user_size
+.I sample_stack_user
 or else the maximum record size.
 .I data
-is the stack data.
+is the stack data (a raw dump of the memory pointed to by the
+stack pointer at the time of sampling).
 .I dyn_size
 is the amount of data actually dumped (can be less than
 .IR size ).
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux