Re: [PATCH] perf lock: show valid sort keys in usage

[Marcin Slusarz <marcin.slusarz@gmail.com>]

On Tue, Feb 22, 2011 at 03:01:10PM -0300, Arnaldo Carvalho de Melo wrote:
> Em Tue, Feb 22, 2011 at 06:45:57PM +0100, Marcin Slusarz escreveu:
> > Signed-off-by: Marcin Slusarz <marcin.slusarz@gmail.com>
> > ---
> >  tools/perf/builtin-lock.c |    2 +-
> >  1 files changed, 1 insertions(+), 1 deletions(-)
> > 
> > diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
> > index 2b36def..0305a40 100644
> > --- a/tools/perf/builtin-lock.c
> > +++ b/tools/perf/builtin-lock.c
> > @@ -893,7 +893,7 @@ static const char * const report_usage[] = {
> >  
> >  static const struct option report_options[] = {
> >  	OPT_STRING('k', "key", &sort_key, "acquired",
> > -		    "key for sorting"),
> > +		    "key for sorting (acquired / contended / wait_total / wait_max / wait_min)"),
> >  	/* TODO: type */
> >  	OPT_END()
> >  };
> 
> Can you please add to tools/perf/Documentation/perf-lock.txt too?

Sure. 

---
From: Marcin Slusarz <marcin.slusarz@gmail.com>
Subject: [PATCH] perf lock: document valid sort keys

Signed-off-by: Marcin Slusarz <marcin.slusarz@gmail.com>
---
 tools/perf/Documentation/perf-lock.txt |   12 ++++++++++--
 tools/perf/builtin-lock.c              |    2 +-
 2 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/tools/perf/Documentation/perf-lock.txt b/tools/perf/Documentation/perf-lock.txt
index 921de25..4d3314b 100644
--- a/tools/perf/Documentation/perf-lock.txt
+++ b/tools/perf/Documentation/perf-lock.txt
@@ -24,8 +24,8 @@ and statistics with this 'perf lock' command.
 
   'perf lock report' reports statistical data.
 
-OPTIONS
--------
+COMMON OPTIONS
+--------------
 
 -i::
 --input=<file>::
@@ -39,6 +39,14 @@ OPTIONS
 --dump-raw-trace::
         Dump raw trace in ASCII.
 
+REPORT OPTIONS
+--------------
+
+-k::
+--key=<value>::
+        Sorting key. Possible values: acquired (default), contended,
+        wait_total, wait_max, wait_min.
+
 SEE ALSO
 --------
 linkperf:perf[1]
diff --git a/tools/perf/builtin-lock.c b/tools/perf/builtin-lock.c
index 2b7eb18..812ad26 100644
--- a/tools/perf/builtin-lock.c
+++ b/tools/perf/builtin-lock.c
@@ -904,7 +904,7 @@ static const char * const report_usage[] = {
 
 static const struct option report_options[] = {
 	OPT_STRING('k', "key", &sort_key, "acquired",
-		    "key for sorting"),
+		    "key for sorting (acquired / contended / wait_total / wait_max / wait_min)"),
 	/* TODO: type */
 	OPT_END()
 };
-- 
1.7.4.rc3