perf lock: Document lock info subcommand
authorNamhyung Kim <namhyung@gmail.com>
Sun, 29 Jan 2012 08:55:56 +0000 (17:55 +0900)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Mon, 30 Jan 2012 20:30:48 +0000 (18:30 -0200)
The commit 26242d859c9be ("perf lock: Add "info" subcommand for dumping
misc information") added the subcommand but missed documentation. Add
it. Also update stale 'trace' subcommand to 'script'.

Cc: Hitoshi Mitake <mitake@dcl.info.waseda.ac.jp>
Cc: Ingo Molnar <mingo@elte.hu>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
Link: http://lkml.kernel.org/r/1327827356-8786-5-git-send-email-namhyung@gmail.com
Signed-off-by: Namhyung Kim <namhyung@gmail.com>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
tools/perf/Documentation/perf-lock.txt
tools/perf/builtin-lock.c

index d6b2a4f2108bf384e8fcb45eb780bd14a3dd122a..c7f5f55634ac3fab974216404fdcb6348aec94d0 100644 (file)
@@ -8,7 +8,7 @@ perf-lock - Analyze lock events
 SYNOPSIS
 --------
 [verse]
-'perf lock' {record|report|trace}
+'perf lock' {record|report|script|info}
 
 DESCRIPTION
 -----------
@@ -20,10 +20,13 @@ and statistics with this 'perf lock' command.
   produces the file "perf.data" which contains tracing
   results of lock events.
 
-  'perf lock trace' shows raw lock events.
-
   'perf lock report' reports statistical data.
 
+  'perf lock script' shows raw lock events.
+
+  'perf lock info' shows metadata like threads or addresses
+  of lock instances.
+
 COMMON OPTIONS
 --------------
 
@@ -47,6 +50,17 @@ REPORT OPTIONS
         Sorting key. Possible values: acquired (default), contended,
         wait_total, wait_max, wait_min.
 
+INFO OPTIONS
+------------
+
+-t::
+--threads::
+       dump thread list in perf.data
+
+-m::
+--map::
+       dump map of lock instances (address:name table)
+
 SEE ALSO
 --------
 linkperf:perf[1]
index 2296c391d0f581246c8c72a913d47357bbb15842..12c8148389931e7e9d2413bd263794a89e88d694 100644 (file)
@@ -922,12 +922,12 @@ static const struct option info_options[] = {
        OPT_BOOLEAN('t', "threads", &info_threads,
                    "dump thread list in perf.data"),
        OPT_BOOLEAN('m', "map", &info_map,
-                   "map of lock instances (name:address table)"),
+                   "map of lock instances (address:name table)"),
        OPT_END()
 };
 
 static const char * const lock_usage[] = {
-       "perf lock [<options>] {record|trace|report}",
+       "perf lock [<options>] {record|report|script|info}",
        NULL
 };