Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit d1eec3ec authored by Namhyung Kim's avatar Namhyung Kim Committed by Arnaldo Carvalho de Melo
Browse files

perf lock: Document lock info subcommand 

The commit 26242d85 ("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: default avatarNamhyung Kim <namhyung@gmail.com>
Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent 008953dc

tools/perf/Documentation/perf-lock.txt

+17 −3
Original line number Original line Diff line number Diff line
@@ -8,7 +8,7 @@ perf-lock - Analyze lock events 
SYNOPSIS

SYNOPSIS

--------

--------

[verse]

[verse]

'perf lock' {record|report|trace}

'perf lock' {record|report|script|info}





DESCRIPTION

DESCRIPTION

-----------

-----------
@@ -20,10 +20,13 @@ and statistics with this 'perf lock' command. 
  produces the file "perf.data" which contains tracing

  produces the file "perf.data" which contains tracing

  results of lock events.

  results of lock events.





  'perf lock trace' shows raw lock events.



  'perf lock report' reports statistical data.

  '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

COMMON OPTIONS

--------------

--------------
@@ -47,6 +50,17 @@ REPORT OPTIONS 
        Sorting key. Possible values: acquired (default), contended,

        Sorting key. Possible values: acquired (default), contended,

        wait_total, wait_max, wait_min.

        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

SEE ALSO

--------

--------

linkperf:perf[1]
 
linkperf:perf[1]

tools/perf/builtin-lock.c

+2 −2
Original line number Original line Diff line number Diff line
@@ -922,12 +922,12 @@ static const struct option info_options[] = { 
	OPT_BOOLEAN('t', "threads", &info_threads,

	OPT_BOOLEAN('t', "threads", &info_threads,

		    "dump thread list in perf.data"),

		    "dump thread list in perf.data"),

	OPT_BOOLEAN('m', "map", &info_map,

	OPT_BOOLEAN('m', "map", &info_map,

		    "map of lock instances (name:address table)"),

		    "map of lock instances (address:name table)"),

	OPT_END()

	OPT_END()

};

};





static const char * const lock_usage[] = {

static const char * const lock_usage[] = {

	"perf lock [<options>] {record|trace|report}",

	"perf lock [<options>] {record|report|script|info}",

	NULL

	NULL

};

};