[PATCH v2 4/5] perf/timer: add document for 'perf timer'

Xiao Guangrong
2009-12-22T13:07:54Z

Add document for 'perf timer', it let people know how to use it

Signed-off-by: Xiao Guangrong <xiaoguangrong@cn.fujitsu.com>
---
tools/perf/Documentation/perf-timer.txt | 50 +++++++++++++++++++++++++++++++
1 files changed, 50 insertions(+), 0 deletions(-)
create mode 100644 tools/perf/Documentation/perf-timer.txt

diff --git a/tools/perf/Documentation/perf-timer.txt b/tools/perf/Documentation/perf-timer.txt
new file mode 100644
index 0000000..5bd26d4
--- /dev/null
+++ b/tools/perf/Documentation/perf-timer.txt
@@ -0,0 +1,50 @@
+perf-timer(1)
+==============
+
+NAME
+----
+perf-timer - Tool to trace/measure timer properties
+
+SYNOPSIS
+--------
+[verse]
+'perf timer' {record|report} [<options>]
+
+DESCRIPTION
+-----------
+There are two variants of perf timer:
+
+ 'perf timer record <command>' to record the timer events
+ of an arbitrary workload.
+
+ 'perf timer report' to report number of activated/expired/canceled
+ timers, timer latency and timer function runtime.
+
+OPTIONS
+-------
+-D::
+--dump-raw-trace=::
+ Display verbose dump of the sched data.
+
+-i <file>::
+--input=<file>::
+ Select the input file (default: perf.data)
+
+-s <key[,key2...]>::
+--sort=<key[,key2...]>::
+ Sort the output (default: type, avg-lat, max-lat,
+ avg-runtime, max-runtime)
+
+--print-lat::
+ Print timer latency
+
+--print-runtime::
+ Print timer function runtime
+
+--type::
+ Timer type selector, you can specify one or more types
+ (timer, hrtimer, itimer-real, itimer-virtual, itimer-prof)
+
+SEE ALSO
+--------
+linkperf:perf-record[1]
--
1.6.1.2