Skip to contentSkip to conversation

perf tool: add example to perf-timechart documentation

PATCH New Ramkumar Ramachandra 2 participants 2 messages Oct 3, 2013 – Oct 15, 2013 perf events

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 perf tool: add example to perf-timechart documentation

While at it, update the synopsis to show both forms.

Cc Ingo Molnar <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc David Ahern <[email protected]>
Cc Arnaldo Carvalho de Melo <[email protected]>
---
 tools/perf/Documentation/perf-timechart.txt | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)
tools/perf/Documentation/perf-timechart.txt +14 -1
index 1632b0e..3ff8bd4 100644
@@ -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]
Signature · 1 line
1.8.4.477.g5d89aa9
#1 lore raw

[tip:perf/core] perf timechart: Add example in the documentation

perf timechart: Add example in the documentation
Commit-ID:  d366c53e1d4fc9d7a5826fd82010b3cffaabe5f1
Gitweb:     http://git.kernel.org/tip/d366c53e1d4fc9d7a5826fd82010b3cffaabe5f1
Author:     Ramkumar Ramachandra <[email protected]>
AuthorDate: Thu, 3 Oct 2013 14:45:16 +0530
Committer:  Arnaldo Carvalho de Melo <[email protected]>
CommitDate: Fri, 11 Oct 2013 12:18:13 -0300

perf timechart: Add example in the documentation

While at it, update the synopsis to show both forms.

---
 tools/perf/Documentation/perf-timechart.txt | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)
tools/perf/Documentation/perf-timechart.txt +14 -1
index 1632b0e..3ff8bd4 100644
@@ -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]