Skip to content

Commit

Permalink
perf lock: Document lock info subcommand
Browse files Browse the repository at this point in the history
The commit 26242d8 ("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>
  • Loading branch information
Namhyung Kim authored and Arnaldo Carvalho de Melo committed Jan 30, 2012
1 parent 008953d commit d1eec3e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
20 changes: 17 additions & 3 deletions tools/perf/Documentation/perf-lock.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ perf-lock - Analyze lock events
SYNOPSIS
--------
[verse]
'perf lock' {record|report|trace}
'perf lock' {record|report|script|info}

DESCRIPTION
-----------
Expand All @@ -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
--------------

Expand All @@ -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]
4 changes: 2 additions & 2 deletions tools/perf/builtin-lock.c
Original file line number Diff line number Diff line change
Expand Up @@ -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
};

Expand Down

0 comments on commit d1eec3e

Please sign in to comment.