perf report: Document +field style argument support for --field option
authorChangbin Du <changbin.du@intel.com>
Mon, 13 Mar 2017 08:32:52 +0000 (16:32 +0800)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Mon, 13 Mar 2017 14:44:44 +0000 (11:44 -0300)
Commit 2f3f9bcf000b ("perf tools: Add +field argument support for
--field option") by Jiri Olsa <jolsa@kernel.org> introduced +field style
argument support for --field option.

This is useful but not updated documentation.  This add a little
description there.

Signed-off-by: Changbin Du <changbin.du@intel.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: http://lkml.kernel.org/r/20170313083252.23644-1-changbin.du@intel.com
[ Slightly improved the phrase structure ]
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
tools/perf/Documentation/perf-report.txt

index 33f91906f5dc0ec783f934b71affbfea99049129..672b149aa80ac485d0946f3784d5e0ef5b486c14 100644 (file)
@@ -173,6 +173,9 @@ OPTIONS
        By default, every sort keys not specified in -F will be appended
        automatically.
 
+       If the keys starts with a prefix '+', then it will append the specified
+        field(s) to the default field order. For example: perf report -F +period,sample.
+
 -p::
 --parent=<regex>::
         A regex filter to identify parent. The parent is a caller of this