summaryrefslogtreecommitdiff
path: root/tools/perf/Documentation/perf-sched.txt
diff options
context:
space:
mode:
authorIngo Molnar <mingo@elte.hu>2009-09-13 16:51:04 +0200
committerIngo Molnar <mingo@elte.hu>2009-09-13 17:55:23 +0200
commitc13f0d3c8165e9592102687fa999da0a0d9c3724 (patch)
tree5f679c0b390a7b7f3b0e116c75ecc0f1784c56a2 /tools/perf/Documentation/perf-sched.txt
parent459ec28ab404d7afcd512ce9b855959ad301605a (diff)
downloadlinux-c13f0d3c8165e9592102687fa999da0a0d9c3724.tar.gz
perf sched: Add 'perf sched trace', improve documentation
Alias 'perf sched trace' to 'perf trace', for workflow completeness. Add a bit of documentation for perf sched. Cc: Peter Zijlstra <a.p.zijlstra@chello.nl> Cc: Mike Galbraith <efault@gmx.de> Cc: Paul Mackerras <paulus@samba.org> Cc: Arnaldo Carvalho de Melo <acme@redhat.com> Cc: Frederic Weisbecker <fweisbec@gmail.com> LKML-Reference: <new-submission> Signed-off-by: Ingo Molnar <mingo@elte.hu>
Diffstat (limited to 'tools/perf/Documentation/perf-sched.txt')
-rw-r--r--tools/perf/Documentation/perf-sched.txt22
1 files changed, 19 insertions, 3 deletions
diff --git a/tools/perf/Documentation/perf-sched.txt b/tools/perf/Documentation/perf-sched.txt
index 056320eecb3a..1ce79198997b 100644
--- a/tools/perf/Documentation/perf-sched.txt
+++ b/tools/perf/Documentation/perf-sched.txt
@@ -3,16 +3,32 @@ perf-sched(1)
NAME
----
-perf-sched - Read perf.data (created by perf record) and display sched output
+perf-sched - Tool to trace/measure scheduler properties (latencies)
SYNOPSIS
--------
[verse]
-'perf sched' [-i <file> | --input=file] symbol_name
+'perf sched' {record|latency|replay|trace}
DESCRIPTION
-----------
-This command reads the input file and displays the latencies recorded.
+There's four variants of perf sched:
+
+ 'perf sched record <command>' to record the scheduling events
+ of an arbitrary workload.
+
+ 'perf sched latency' to report the per task scheduling latencies
+ and other scheduling properties of the workload.
+
+ 'perf sched trace' to see a detailed trace of the workload that
+ was recorded.
+
+ 'perf sched replay' to simulate the workload that was recorded
+ via perf sched record. (this is done by starting up mockup threads
+ that mimic the workload based on the events in the trace. These
+ threads can then replay the timings (CPU runtime and sleep patterns)
+ of the workload as it occured when it was recorded - and can repeat
+ it a number of times, measuring its performance.)
OPTIONS
-------