perf ftrace: Make option description initials all capital letters
authorArnaldo Carvalho de Melo <acme@redhat.com>
Fri, 14 Aug 2020 12:55:33 +0000 (09:55 -0300)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Fri, 14 Aug 2020 12:55:33 +0000 (09:55 -0300)
And improve a bit the -m description to state that a B/K/M/G suffix is
needed.

Cc: Changbin Du <changbin.du@gmail.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Steven Rostedt (VMware) <rostedt@goodmis.org>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
tools/perf/builtin-ftrace.c

index 167f1f5..1d44bc2 100644 (file)
@@ -816,42 +816,42 @@ int cmd_ftrace(int argc, const char **argv)
        };
        const struct option ftrace_options[] = {
        OPT_STRING('t', "tracer", &ftrace.tracer, "tracer",
-                  "tracer to use: function_graph(default) or function"),
+                  "Tracer to use: function_graph(default) or function"),
        OPT_BOOLEAN('F', "funcs", &ftrace.list_avail_functions,
                    "Show available functions to filter"),
        OPT_STRING('p', "pid", &ftrace.target.pid, "pid",
-                  "trace on existing process id"),
+                  "Trace on existing process id"),
        /* TODO: Add short option -t after -t/--tracer can be removed. */
        OPT_STRING(0, "tid", &ftrace.target.tid, "tid",
-                  "trace on existing thread id (exclusive to --pid)"),
+                  "Trace on existing thread id (exclusive to --pid)"),
        OPT_INCR('v', "verbose", &verbose,
-                "be more verbose"),
+                "Be more verbose"),
        OPT_BOOLEAN('a', "all-cpus", &ftrace.target.system_wide,
-                   "system-wide collection from all CPUs"),
+                   "System-wide collection from all CPUs"),
        OPT_STRING('C', "cpu", &ftrace.target.cpu_list, "cpu",
-                   "list of cpus to monitor"),
+                   "List of cpus to monitor"),
        OPT_CALLBACK('T', "trace-funcs", &ftrace.filters, "func",
-                    "trace given functions using function tracer",
+                    "Trace given functions using function tracer",
                     parse_filter_func),
        OPT_CALLBACK('N', "notrace-funcs", &ftrace.notrace, "func",
-                    "do not trace given functions", parse_filter_func),
+                    "Do not trace given functions", parse_filter_func),
        OPT_CALLBACK(0, "func-opts", &ftrace, "options",
-                    "function tracer options, available options: call-graph,irq-info",
+                    "Function tracer options, available options: call-graph,irq-info",
                     parse_func_tracer_opts),
        OPT_CALLBACK('G', "graph-funcs", &ftrace.graph_funcs, "func",
-                    "trace given functions using function_graph tracer",
+                    "Trace given functions using function_graph tracer",
                     parse_filter_func),
        OPT_CALLBACK('g', "nograph-funcs", &ftrace.nograph_funcs, "func",
                     "Set nograph filter on given functions", parse_filter_func),
        OPT_CALLBACK(0, "graph-opts", &ftrace, "options",
-                    "graph tracer options, available options: nosleep-time,noirqs,verbose,thresh=<n>,depth=<n>",
+                    "Graph tracer options, available options: nosleep-time,noirqs,verbose,thresh=<n>,depth=<n>",
                     parse_graph_tracer_opts),
        OPT_CALLBACK('m', "buffer-size", &ftrace.percpu_buffer_size, "size",
-                    "size of per cpu buffer", parse_buffer_size),
+                    "Size of per cpu buffer, needs to use a B, K, M or G suffix.", parse_buffer_size),
        OPT_BOOLEAN(0, "inherit", &ftrace.inherit,
-                   "trace children processes"),
+                   "Trace children processes"),
        OPT_UINTEGER('D', "delay", &ftrace.initial_delay,
-                    "ms to wait before starting tracing after program start"),
+                    "Number of milliseconds to wait before starting tracing after program start"),
        OPT_END()
        };