Merge branch 'perf/core'

[karo-tx-linux.git] / tools / perf / Documentation / perf-trace.txt

diff --git a/tools/perf/Documentation/perf-trace.txt b/tools/perf/Documentation/perf-trace.txt
index daccd2c0a48fe9c933cf50c870f68aa9bfe253a6..7b0497f95a75f0dafdf079742cec136dcff3ffdc 100644 (file)
--- a/tools/perf/Documentation/perf-trace.txt
+++ b/tools/perf/Documentation/perf-trace.txt
@@ -9,6 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'perf trace'
 --------
 [verse]
 'perf trace'

+'perf trace record'

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -16,9 +17,14 @@ This command will show the events associated with the target, initially
 syscalls, but other system events like pagefaults, task lifetime events,
 scheduling events, etc.
 
 syscalls, but other system events like pagefaults, task lifetime events,
 scheduling events, etc.
 

-Initially this is a live mode only tool, but eventually will work with
-perf.data files like the other tools, allowing a detached 'record' from
-analysis phases.
+This is a live mode tool in addition to working with perf.data files like
+the other perf tools. Files can be generated using the 'perf record' command
+but the session needs to include the raw_syscalls events (-e 'raw_syscalls:*').
+Alernatively, the 'perf trace record' can be used as a shortcut to
+automatically include the raw_syscalls events when writing events to a file.
+
+The following options apply to perf trace; options to perf trace record are
+found in the perf record man page.

 
 OPTIONS
 -------
 
 OPTIONS
 -------


@@ -59,7 +65,9 @@ OPTIONS
 
 -m::
 --mmap-pages=::
 
 -m::
 --mmap-pages=::

-       Number of mmap data pages. Must be a power of two.
+       Number of mmap data pages (must be a power of two) or size
+       specification with appended unit character - B/K/M/G. The
+       size is rounded up to have nearest pages power of two value.

 
 -C::
 --cpu::
 
 -C::
 --cpu::


@@ -78,6 +86,21 @@ the thread executes on the designated CPUs. Default is to monitor all CPUs.
 --input
        Process events from a given perf data file.
 
 --input
        Process events from a given perf data file.
 

+-T
+--time
+       Print full timestamp rather time relative to first sample.
+
+--comm::
+        Show process COMM right beside its ID, on by default, disable with --no-comm.
+
+--summary::
+       Show a summary of syscalls by thread with min, max, and average times (in
+    msec) and relative stddev.
+
+--tool_stats::
+       Show tool stats such as number of times fd->pathname was discovered thru
+       hooking the open syscall return + vfs_getname or via reading /proc/pid/fd, etc.
+

 SEE ALSO
 --------
 linkperf:perf-record[1], linkperf:perf-script[1]
 SEE ALSO
 --------
 linkperf:perf-record[1], linkperf:perf-script[1]