Skip to contentSkip to conversation

trace-cmd documentation updates

PATCH New Tzvetomir Stoyanov (VMware) 1 participant 3 messages Jul 17, 2020 Documentation

lore
Share & tools
lore
#0 lore raw

cover trace-cmd documentation updates

Documented "trace-cmd report --cpu ..." option
Added new man page for trace-cmd clear subcommand

Tzvetomir Stoyanov (VMware) (2):
trace-cmd: Man page of trace-cmd clear subcommand
trace-cmd: Document "trace-cmd report --cpu ..." option

 Documentation/trace-cmd-clear.1.txt  | 40 ++++++++++++++++++++++++++++
 Documentation/trace-cmd-report.1.txt |  9 +++++++
 tracecmd/trace-usage.c               |  2 ++
 3 files changed, 51 insertions(+)
 create mode 100644 Documentation/trace-cmd-clear.1.txt
Signature · 1 line
2.26.2
#1 lore raw

PATCH 1/2 trace-cmd: Man page of trace-cmd clear subcommand

Added man page describing trace-cmd clear subcommand.

---
 Documentation/trace-cmd-clear.1.txt | 40 +++++++++++++++++++++++++++++
 1 file changed, 40 insertions(+)
 create mode 100644 Documentation/trace-cmd-clear.1.txt
Documentation/trace-cmd-clear.1.txt new file +40 -0
new file mode 100644
index 00000000..67e5851a
@@ -0,0 +1,40 @@
+TRACE-CMD-CLEAR(1)
+=================
+
+NAME
+----
+trace-cmd-clear - clear the Ftrace buffer.
+
+SYNOPSIS
+--------
+*trace-cmd clear*
+
+DESCRIPTION
+-----------
+The *trace-cmd(1) clear* clears the content of the Ftrace ring buffer.
+
+SEE ALSO
+--------
+trace-cmd(1), trace-cmd-record(1), trace-cmd-report(1), trace-cmd-start(1),
+trace-cmd-extract(1), trace-cmd-reset(1), trace-cmd-split(1),
+trace-cmd-list(1), trace-cmd-listen(1)
+
+AUTHOR
+------
+[verse]
+--
+*Steven Rostedt* <[email protected]>, author of *trace-cmd*.
+*Tzvetomir Stoyanov* <[email protected]>, author of this man page.
+--
+REPORTING BUGS
+--------------
+Report bugs to  <[email protected]>
+
+LICENSE
+-------
+trace-cmd is Free Software licensed under the terms of the
+GNU Public License (GPL).
+
+RESOURCES
+---------
+https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git
\ No newline at end of file
Signature · 1 line
2.26.2
#2 lore raw

PATCH 2/2 trace-cmd: Document "trace-cmd report --cpu ..." option

In reply to Tzvetomir Stoyanov (VMware)

Added description of "trace-cmd report --cpu ..." option in "trace-cmd report --help" output and in "trace-cmd report" man page.

---
 Documentation/trace-cmd-report.1.txt | 9 +++++++++
 tracecmd/trace-usage.c               | 2 ++
 2 files changed, 11 insertions(+)
Documentation/trace-cmd-report.1.txt +9 -0
index 66e96da7..864eb2d7 100644
@@ -242,6 +242,15 @@ OPTIONS
 
      Example:  -O fgraph:tailprint
 
+*--cpu* <cpu list>::
+    List of CPUs, separated by "," or ":", used for filtering the events.
+    A range of CPUs can be specified using "cpuX-cpuY" notation, where all CPUs
+    in the range between cpuX and cpuY will be included in the list. The order
+    of CPUs in the list must be from lower to greater.
+
+    Example:  "--cpu 0,3" - show events from CPUs 0 and 3
+              "--cpu 2-4" - show events from CPUs 2, 3 and 4
+
 *--stat*::
     If the trace.dat file recorded the final stats (outputed at the end of record)
     the *--stat* option can be used to retrieve them.
tracecmd/trace-usage.c +2 -0
index 85c63512..3f0b2d07 100644
@@ -209,6 +209,8 @@ static struct usage_help usage_help[] = {
 		"          -w show wakeup latencies\n"
 		"          -l show latency format (default with latency tracers)\n"
 		"          -O plugin option -O [plugin:]var[=val]\n"
+		"          --cpu <cpu1,cpu2,...> - filter events according to the given cpu list.\n"
+		"                                  A range of CPUs can be specified using 'cpuX-cpuY' notation.\n"
 		"          --check-events return whether all event formats can be parsed\n"
 		"          --stat - show the buffer stats that were reported at the end of the record.\n"
 		"          --uname - show uname of the record, if it was saved\n"
Signature · 1 line
2.26.2