[v2,85/87] tarce-cmd: Man page for "trace-cmd convert"

Message ID	20210729050959.12263-86-tz.stoyanov@gmail.com (mailing list archive)
State	Superseded
Headers	show Return-Path: <linux-trace-devel-owner@kernel.org> From: "Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com> To: rostedt@goodmis.org Cc: linux-trace-devel@vger.kernel.org Subject: [PATCH v2 85/87] tarce-cmd: Man page for "trace-cmd convert" Date: Thu, 29 Jul 2021 08:09:57 +0300 Message-Id: <20210729050959.12263-86-tz.stoyanov@gmail.com> In-Reply-To: <20210729050959.12263-1-tz.stoyanov@gmail.com> References: <20210729050959.12263-1-tz.stoyanov@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	Trace file version 7 \| expand [v2,00/87] Trace file version 7 [v2,01/87] trace-cmd library: Read option id with correct endian [v2,02/87] trace-cmd report: Fix typos in error messages [v2,03/87] tarce-cmd library: Fix version string memory leak [v2,04/87] trace-cmd library: Fixed a memory leak on input handler close [v2,05/87] trace-cmd library: Fix possible memory corruption on processing a trace buffer [v2,06/87] trace-cmd library: Add constructor and destructor [v2,07/87] trace-cmd library: Add cache functionality to network message handler [v2,08/87] trace-cmd library: Add support for compression algorithms [v2,09/87] trace-cmd list: Show supported compression algorithms [v2,10/87] trace-cmd library: Internal helpers for compressing data [v2,11/87] trace-cmd library: Internal helpers for uncompressing data [v2,12/87] trace-cmd library: Define trace file version 7 [v2,13/87] trace-cmd library: Refactor APIs for creating output handler [v2,14/87] trace-cmd library: Reuse within the library the function that checks file state. [v2,15/87] trace-cmd library: New API to get the version of output handler [v2,16/87] trace-cmd library: Inherit compression algorithm from input file [v2,17/87] trace-cmd library: New API to configure compression on an output handler [v2,18/87] trace-cmd record: Add compression to the trace context [v2,19/87] trace-cmd library: Write compression header in the trace file [v2,20/87] trace-cmd library: Compress part of the trace file [v2,21/87] trace-cmd library: Add internal helper functon for writing headers before file sections [v2,22/87] trace-cmd library: Write header before file sections [v2,23/87] trace-cmd library: Refactor the logic for writing trace data in the file [v2,24/87] trace-cmd library: Add local helper function for data compression [v2,25/87] trace-cmd library: Compress the trace data [v2,26/87] tarce-cmd library: Add multiple options sections in trace file version 7 [v2,27/87] trace-cmd library: Do not write CPU count section in trace files version 7 [v2,28/87] trace-cmd library: Move CPU flyrecord trace metadata into the buffer option, for trace f… [v2,29/87] trace-cmd record: Append trace options after the trace data are written [v2,30/87] trace-cmd library: Add section header before flyrecord trace data [v2,31/87] trace-cmd library: Fit CPU latency trace data in the new trace file version 7 format [v2,32/87] trace-cmd library: Do not write CPUs with empty trace data [v2,33/87] trace-cmd library: Add macro to check file state on reading [v2,34/87] trace-cmd library: Introduce sections in trace file reading logic [v2,35/87] trace-cmd library: Initialize internal sections database on file read [v2,36/87] trace-cmd library: Use sections database when reading parts of the trace file [v2,37/87] trace-cmd library: Set log size to the input tep handler when it is read from the file [v2,38/87] trace-cmd library: Fix possible memory leak in read_ftrace_files() [v2,39/87] trace-cmd library: Fix possible memory leak in read_event_files() [v2,40/87] trace-cmd library: Fix possible memory leak in read_proc_kallsyms() [v2,41/87] trace-cmd library: Fix possible memory leak in read_ftrace_printk() [v2,42/87] trace-cmd library: Fix possible memory leak in read_and_parse_cmdlines() [v2,43/87] trace-cmd library: Track maximum CPUs count in input handler [v2,44/87] trace-cmd library: Set input handler default values in allocation function [v2,45/87] trace-cmd library: Read headers from trace file version 7 [v2,46/87] tarce-cmd library: Do not use local variables when reading CPU stat option [v2,47/87] trace-cmd library: Read handle header and compression of the option section [v2,48/87] trace-cmd library: Read extended BUFFER option [v2,49/87] trace-cmd library: Handle the extended DONE option [v2,50/87] trace-cmd library: Read compression header [v2,51/87] trace-cmd library: Extend the input handler with trace data decompression context [v2,52/87] trace-cmd library: Initialize CPU data decompression logic [v2,53/87] trace-cmd library: Initialize CPU data for reading from version 7 trace files [v2,54/87] trace-cmd library: Add logic for in-memory decompression [v2,55/87] trace-cmd library: Handle latency trace in version 7 files [v2,56/87] trace-cmd library: Handle buffer trace data init for version 7 files [v2,57/87] trace-cmd report: Use the new latency API to read data [v2,58/87] trace-cmd report: Close input file handlers on exit [v2,59/87] trace-cmd report: Do not print empty buffer name [v2,60/87] trace-cmd report: Init the top trace instance earlier [v2,61/87] trace-cmd: Call additional APIs when creating trace file [v2,62/87] trace-cmd dump: Add helpers for processing trace file version 7 [v2,63/87] trace-cmd dump: Print compression header [v2,64/87] trace-cmd dump: Add helpers for processing trace file sections [v2,65/87] trace-cmd dump: Read recursively all options sections [v2,66/87] trace-cmd dump: Read extended BUFFER option [v2,67/87] trace-cmd dump: Dump sections [v2,68/87] trace-cmd dump: Dump trace file version 7 [v2,69/87] trace-cmd dump: Dump sections content [v2,70/87] trace-cmd dump: Add new argument --sections [v2,71/87] trace-cmd dump: Align better the output of flyrecord dump [v2,72/87] trace-cmd library: Add zlib compression algorithm [v2,73/87] trace-cmd library: Reuse local function that writes to output handler [v2,74/87] trace-cmd library: Use output handler when copying data from input file [v2,75/87] trace-cmd library: Handle version 7 files when copying headers between files [v2,76/87] tarce-cmd library: Copy CPU count between trace files [v2,77/87] tarce-cmd library: New API to copy buffer description between trace files [v2,78/87] tarce-cmd library: New API to copy options between trace files [v2,79/87] tarce-cmd library: New API to copy trace data between trace files [v2,80/87] trace-cmd library: Extend tracecmd_copy() API [v2,81/87] trace-cmd library: Set correct CPU to the record, retrieved with tracecmd_peek_data [v2,82/87] trace-cmd: Add new subcommand "convert" [v2,83/87] trace-cmd report: Add new parameters for version 7 trace files [v2,84/87] trace-cmd: Update bash completion [v2,85/87] tarce-cmd: Man page for "trace-cmd convert" [v2,86/87] tarce-cmd: Update record man page [v2,87/87] trace-cmd: Document trace file version 7

Message ID

20210729050959.12263-86-tz.stoyanov@gmail.com (mailing list archive)

State

Superseded

Headers

From: "Tzvetomir Stoyanov (VMware)" <tz.stoyanov@gmail.com>
To: rostedt@goodmis.org
Cc: linux-trace-devel@vger.kernel.org
Subject: [PATCH v2 85/87] tarce-cmd: Man page for "trace-cmd convert"
Date: Thu, 29 Jul 2021 08:09:57 +0300
Message-Id: <20210729050959.12263-86-tz.stoyanov@gmail.com>
In-Reply-To: <20210729050959.12263-1-tz.stoyanov@gmail.com>
References: <20210729050959.12263-1-tz.stoyanov@gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Series

Trace file version 7 | expand

Commit Message

Tzvetomir Stoyanov (VMware) July 29, 2021, 5:09 a.m. UTC

Documented new "trace-cmnd convert" subcommand.

Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
---
 .../trace-cmd/trace-cmd-convert.1.txt         | 65 +++++++++++++++++++
 Documentation/trace-cmd/trace-cmd.1.txt       |  4 +-
 2 files changed, 68 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/trace-cmd/trace-cmd-convert.1.txt

diff --git a/Documentation/trace-cmd/trace-cmd-convert.1.txt b/Documentation/trace-cmd/trace-cmd-convert.1.txt
new file mode 100644
index 00000000..7c13cf3d
--- /dev/null
+++ b/Documentation/trace-cmd/trace-cmd-convert.1.txt
@@ -0,0 +1,65 @@ 
+TRACE-CMD-CONVERT(1)
+===================
+
+NAME
+----
+trace-cmd-convert - convert trace files
+
+SYNOPSIS
+--------
+*trace-cmd convert* ['OPTIONS'] ['output-file']
+
+DESCRIPTION
+-----------
+The trace-cmd(1) convert command converts trace file. It reads the input file and copies the data
+into an output file. The output file may be in different format, depending on the command line
+arguments.
+
+OPTIONS
+-------
+*-i* 'input-file'::
+    By default, trace-cmd convert will read the file 'trace.dat'. But the *-i*
+    option open up the given 'input-file' instead.
+
+*-o* 'out-file'::
+    The name of the output file, this parameter is mandatory. Note, the output file may also be
+    specified as the last item on the command line.
+
+*--file-version*::
+    Desired version of the output file. Supported versions are 6 or 7.
+
+*--compression*::
+    Compression of the trace output file, one of these strings can be passed:
+
+    'any'  - auto select the best available compression algorithm
+
+    'none' - do not compress the trace file
+
+    'name' - the name of the desired compression algorithms. Available algorithms can be listed with
+    trace-cmd list -c
+
+*--help*::
+    Print usage information.
+
+EXAMPLES
+--------
+
+# trace-cmd convert --compression any trace_compress.dat
+
+SEE ALSO
+--------
+trace-cmd(1), trace-cmd.dat(1)
+
+AUTHOR
+------
+*Steven Rostedt* <rostedt@goodmis.org>, author of *trace-cmd*.
+*Tzvetomir Stoyanov* <tz.stoyanov@gmail.com>, author of this man page.
+
+RESOURCES
+---------
+https://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/
+
+COPYING
+-------
+Copyright \(C) 2021 VMware. Free use of this software is granted under
+the terms of the GNU Public License (GPL).
diff --git a/Documentation/trace-cmd/trace-cmd.1.txt b/Documentation/trace-cmd/trace-cmd.1.txt
index b330b4fe..27c6e973 100644
--- a/Documentation/trace-cmd/trace-cmd.1.txt
+++ b/Documentation/trace-cmd/trace-cmd.1.txt
@@ -58,6 +58,8 @@  COMMANDS
   check-events - parse format strings for all trace events and return
                  whether all formats are parseable
 
+  convert   - convert trace files
+
 OPTIONS
 -------
 
@@ -70,7 +72,7 @@  SEE ALSO
 --------
 trace-cmd-record(1), trace-cmd-report(1), trace-cmd-hist(1), trace-cmd-start(1),
 trace-cmd-stop(1), trace-cmd-extract(1), trace-cmd-reset(1),
-trace-cmd-restore(1), trace-cmd-stack(1),
+trace-cmd-restore(1), trace-cmd-stack(1), trace-cmd-convert(1),
 trace-cmd-split(1), trace-cmd-list(1), trace-cmd-listen(1),
 trace-cmd.dat(5), trace-cmd-check-events(1) trace-cmd-stat(1)

[v2,85/87] tarce-cmd: Man page for "trace-cmd convert"

Commit Message

Patch