mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] trace-cmd: s/plugin/tracer/ in record's man page
@ 2017-11-17 17:54 Vladislav Valtchev (VMware)
  0 siblings, 0 replies; only message in thread
From: Vladislav Valtchev (VMware) @ 2017-11-17 17:54 UTC (permalink / raw)
  To: rostedt, linux-kernel; +Cc: y.karadz, Vladislav Valtchev (VMware)

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.

Signed-off-by: Vladislav Valtchev (VMware) <vladislav.valtchev@gmail.com>
---
 Documentation/trace-cmd-record.1.txt | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/Documentation/trace-cmd-record.1.txt b/Documentation/trace-cmd-record.1.txt
index 5663447..68afa16 100644
--- a/Documentation/trace-cmd-record.1.txt
+++ b/Documentation/trace-cmd-record.1.txt
@@ -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
-- 
2.14.1

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2017-11-17 17:55 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-11-17 17:54 [PATCH] trace-cmd: s/plugin/tracer/ in record's man page Vladislav Valtchev (VMware)

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®