path: root/tools/perf/Documentation/perf-sched.txt
diff options
Diffstat (limited to 'tools/perf/Documentation/perf-sched.txt')
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)
-perf-sched - Read (created by perf record) and display sched output
+perf-sched - Tool to trace/measure scheduler properties (latencies)
-'perf sched' [-i <file> | --input=file] symbol_name
+'perf sched' {record|latency|replay|trace}
-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.)