perf tools: Report itrace options in help

I often forget all the options that --itrace accepts. Instead of burying
them in the man page only report them in the normal command line help
too to make them easier accessible.

v2: Align

Signed-off-by: Andi Kleen <ak@linux.intel.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Kim Phillips <kim.phillips@arm.com>
Link: http://lkml.kernel.org/r/20180914031038.4160-2-andi@firstfloor.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

diff --git a/tools/perf/builtin-inject.c b/tools/perf/builtin-inject.c
index b4a29f435b06ea5c0b3d5a4334fb434341038463..eda41673c4f3c6360a821a625127917993f8a485 100644 (file)
--- a/tools/perf/builtin-inject.c
+++ b/tools/perf/builtin-inject.c
@@ -798,7 +798,8 @@ int cmd_inject(int argc, const char **argv)
                           "kallsyms pathname"),
                OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"),
                OPT_CALLBACK_OPTARG(0, "itrace", &inject.itrace_synth_opts,
-                                   NULL, "opts", "Instruction Tracing options",
+                                   NULL, "opts", "Instruction Tracing options\n"
+                                   ITRACE_HELP,
                                    itrace_parse_synth_opts),
                OPT_BOOLEAN(0, "strip", &inject.strip,
                            "strip non-synthesized events (use with --itrace)"),

diff --git a/tools/perf/builtin-report.c b/tools/perf/builtin-report.c
index 7507e4d6dce1a65cdc90cb9bf37fce9472efe3e1..c0703979c51d086aca2c5b5f4bb3e964e22bd856 100644 (file)
--- a/tools/perf/builtin-report.c
+++ b/tools/perf/builtin-report.c
@@ -1104,7 +1104,7 @@ int cmd_report(int argc, const char **argv)
        OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
                     "how to display percentage of filtered entries", parse_filter_percentage),
        OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
-                           "Instruction Tracing options",
+                           "Instruction Tracing options\n" ITRACE_HELP,
                            itrace_parse_synth_opts),
        OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
                        "Show full source file name path for source lines"),

diff --git a/tools/perf/builtin-script.c b/tools/perf/builtin-script.c
index 765391b6c88ce56be51bc9d1fb99de4cd16fbaf8..66699dd351e09e54564eb9b9a2005b91a9b44d37 100644 (file)
--- a/tools/perf/builtin-script.c
+++ b/tools/perf/builtin-script.c
@@ -3193,7 +3193,7 @@ int cmd_script(int argc, const char **argv)
        OPT_BOOLEAN(0, "ns", &nanosecs,
                    "Use 9 decimal places when displaying time"),
        OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
-                           "Instruction Tracing options",
+                           "Instruction Tracing options\n" ITRACE_HELP,
                            itrace_parse_synth_opts),
        OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
                        "Show full source file name path for source lines"),

diff --git a/tools/perf/util/auxtrace.h b/tools/perf/util/auxtrace.h
index a86b7eab66734d27a0afc8cbea7cfdb28a91711a..0a6ce9c4fc1187b6a9d852d87387c21f64c61cb5 100644 (file)
--- a/tools/perf/util/auxtrace.h
+++ b/tools/perf/util/auxtrace.h
@@ -576,6 +576,23 @@ static inline void auxtrace__free(struct perf_session *session)
        return session->auxtrace->free(session);
 }
 
+#define ITRACE_HELP \
+"                              i:                      synthesize instructions events\n"               \
+"                              b:                      synthesize branches events\n"           \
+"                              c:                      synthesize branches events (calls only)\n"      \
+"                              r:                      synthesize branches events (returns only)\n" \
+"                              x:                      synthesize transactions events\n"               \
+"                              w:                      synthesize ptwrite events\n"            \
+"                              p:                      synthesize power events\n"                      \
+"                              e:                      synthesize error events\n"                      \
+"                              d:                      create a debug log\n"                   \
+"                              g[len]:                 synthesize a call chain (use with i or x)\n" \
+"                              l[len]:                 synthesize last branch entries (use with i or x)\n" \
+"                              sNUMBER:                skip initial number of events\n"                \
+"                              PERIOD[ns|us|ms|i|t]:   specify period to sample stream\n" \
+"                              concatenate multiple options. Default is ibxwpe or cewp\n"
+
+
 #else
 
 static inline struct auxtrace_record *
@@ -716,6 +733,8 @@ void auxtrace_mmap_params__set_idx(struct auxtrace_mmap_params *mp,
                                   struct perf_evlist *evlist, int idx,
                                   bool per_cpu);
 
+#define ITRACE_HELP ""
+
 #endif
 
 #endif