Skip to contentSkip to conversation

trace-cmd: s/plugin/tracer/ in record's man page

PATCH New Vladislav Valtchev (VMware) 1 participant 1 message Nov 17, 2017 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 trace-cmd: s/plugin/tracer/ in record's man page

Currently, the man page of trace-cmd record states that:
To see a list of available plugins, see trace-cmd-list(1).
While trace-cmd list [w/o options] mentions "tracers", which is the proper term there. The inconsistency exists because the terminology in trace-cmd/ftrace changed over time: what we call today "tracers" use to be called "plugins" when ftrace was created. This simple patch updates trace-cmd record's man page accordingly, in order to avoid any confusion and improve the user experience.

---
 Documentation/trace-cmd-record.1.txt | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)
Documentation/trace-cmd-record.1.txt +5 -6
index 5663447..68afa16 100644
@@ -25,12 +25,11 @@ file that can later be read (see trace-cmd-report(1)).
 
 OPTIONS
 -------
-*-p* 'plugin'::
-    Specify a trace plugin. Plugins are special Ftrace tracers that usually do
-    more than just trace an event. Common plugins are *function*,
-    *function_graph*, *preemptirqsoff*, *irqsoff*, *preemptoff*, and *wakeup*.
-    A plugin must be supported by the running kernel. To see a list of
-    available plugins, see trace-cmd-list(1).
+*-p* 'tracer'::
+    Specify a tracer. Tracers usually do more than just trace an event.
+    Common tracers are: *function*, *function_graph*, *preemptirqsoff*,
+    *irqsoff*, *preemptoff* and *wakeup*. A tracer must be supported by the
+    running kernel. To see a list of available tracers, see trace-cmd-list(1).
 
 *-e* 'event'::
     Specify an event to trace. Various static trace points have been added to
Signature · 1 line
2.14.1