summaryrefslogtreecommitdiffstats
path: root/tools/perf/Documentation/perf-timechart.txt
diff options
context:
space:
mode:
authorRamkumar Ramachandra <artagnon@gmail.com>2013-10-03 14:45:16 +0530
committerArnaldo Carvalho de Melo <acme@redhat.com>2013-10-11 12:18:13 -0300
commitd366c53e1d4fc9d7a5826fd82010b3cffaabe5f1 (patch)
treef95dd72a04efa140ac3d1400f73e5657fa741aec /tools/perf/Documentation/perf-timechart.txt
parent8a5411e9a3e65ab70b094022e5aa6deaec82ae7c (diff)
perf timechart: Add example in the documentation
While at it, update the synopsis to show both forms. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Cc: David Ahern <dsahern@gmail.com> Cc: Ingo Molnar <mingo@kernel.org> Cc: Namhyung Kim <namhyung@gmail.com> Link: http://lkml.kernel.org/r/1380791716-10325-1-git-send-email-artagnon@gmail.com Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
Diffstat (limited to 'tools/perf/Documentation/perf-timechart.txt')
-rw-r--r--tools/perf/Documentation/perf-timechart.txt15
1 files changed, 14 insertions, 1 deletions
diff --git a/tools/perf/Documentation/perf-timechart.txt b/tools/perf/Documentation/perf-timechart.txt
index 1632b0efc757..3ff8bd4f0b4d 100644
--- a/tools/perf/Documentation/perf-timechart.txt
+++ b/tools/perf/Documentation/perf-timechart.txt
@@ -8,7 +8,8 @@ perf-timechart - Tool to visualize total system behavior during a workload
SYNOPSIS
--------
[verse]
-'perf timechart' {record}
+'perf timechart' record <command>
+'perf timechart' [<options>]
DESCRIPTION
-----------
@@ -41,6 +42,18 @@ OPTIONS
--symfs=<directory>::
Look for files with symbols relative to this directory.
+EXAMPLES
+--------
+
+$ perf timechart record git pull
+
+ [ perf record: Woken up 13 times to write data ]
+ [ perf record: Captured and wrote 4.253 MB perf.data (~185801 samples) ]
+
+$ perf timechart
+
+ Written 10.2 seconds of trace to output.svg.
+
SEE ALSO
--------
linkperf:perf-record[1]