[v6,42/45] trace-cmd: Add convert man page

Message ID	20210614075029.598048-43-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 v6 42/45] trace-cmd: Add convert man page Date: Mon, 14 Jun 2021 10:50:26 +0300 Message-Id: <20210614075029.598048-43-tz.stoyanov@gmail.com> In-Reply-To: <20210614075029.598048-1-tz.stoyanov@gmail.com> References: <20210614075029.598048-1-tz.stoyanov@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	Add trace file compression \| expand [v6,00/45] Add trace file compression [v6,01/45] trace-cmd library: Remove unused private APIs for creating trace files [v6,02/45] trace-cmd library: Remove unused API tracecmd_update_option [v6,03/45] trace-cmd: Check if file version is supported [v6,04/45] trace-cmd library: Add new API to get file version of input handler [v6,05/45] trace-cmd library: Select the file version when writing trace file [v6,06/45] trace-cmd: Add APIs for library initialization and free [v6,07/45] trace-cmd library: Add support for compression algorithms [v6,08/45] trace-cmd list: Show supported compression algorithms [v6,09/45] trace-cmd library: Bump the trace file version to 7 [v6,10/45] trace-cmd library: Compress part of the trace file [v6,11/45] trace-cmd library: Read compressed trace file [v6,12/45] trace-cmd library: Add new API to get compression of input handler [v6,13/45] trace-cmd library: Inherit compression algorithm from input file [v6,14/45] trace-cmd library: Extend the create file APIs to support different compression [v6,15/45] trace-cmd record: Add new parameter --compression [v6,16/45] trace-cmd dump: Add support for trace files version 7 [v6,17/45] trace-cmd library: Add support for zlib compression library [v6,18/45] trace-cmd library: Hide the logic for updating buffer offset [v6,19/45] trace-cmd: Move buffers description outside of options [v6,20/45] trace-cmd library: Track the offset in the option section in the trace file [v6,21/45] trace-cmd library: Add compression of the option section of the trace file [v6,22/45] trace-cmd library: Refactor the logic for writing trace data in the file [v6,23/45] trace-cmd library: Add APIs for read and write compressed data in chunks [v6,24/45] trace-cmd: Compress trace data [v6,25/45] trace-cmd: Read compressed trace data [v6,26/45] trace-cmd library: Compress latency trace data [v6,27/45] trace-cmd: Read compressed latency trace data [v6,28/45] trace-cmd library: Reuse within the library the function that checks file state. [v6,29/45] trace-cmd library: Make tracecmd_copy_headers() to work with output handler [v6,30/45] trace-cmd: Do not use trace file compression with streams [v6,31/45] trace-cmd library: Add new API to get file version of output handler [v6,32/45] trace-cmd: Add file state parameter to tracecmd_copy [v6,33/45] trace-cmd: Copy CPU count in tracecmd_copy [v6,34/45] trace-cmd: Copy buffers description in tracecmd_copy [v6,35/45] trace-cmd: Copy options in tracecmd_copy [v6,36/45] trace-cmd library: Refactor the logic for writing CPU trace data [v6,37/45] trace-cmd library: Refactor the logic for writing CPU instance trace data [v6,38/45] trace-cmd: Copy trace data in tracecmd_copy [v6,39/45] trace-cmd: Add compression parameter to tracecmd_copy [v6,40/45] trace-cmd: Add new command "trace-cmd convert" [v6,41/45] trace-cmd record: Update man page [v6,42/45] trace-cmd: Add convert man page [v6,43/45] trace-cmd: Update bash completion [v6,44/45] trace-cmd list: Update the man page [v6,45/45] trace-cmd: Update trace.dat man page

Message ID

20210614075029.598048-43-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 v6 42/45] trace-cmd: Add convert man page
Date: Mon, 14 Jun 2021 10:50:26 +0300
Message-Id: <20210614075029.598048-43-tz.stoyanov@gmail.com>
In-Reply-To: <20210614075029.598048-1-tz.stoyanov@gmail.com>
References: <20210614075029.598048-1-tz.stoyanov@gmail.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

Series

Add trace file compression | expand

Commit Message

Tzvetomir Stoyanov (VMware) June 14, 2021, 7:50 a.m. UTC

Added new man page, documenting the "trace-cmd convert" command.

Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@gmail.com>
---
 .../trace-cmd/trace-cmd-convert.1.txt         | 60 +++++++++++++++++++
 Documentation/trace-cmd/trace-cmd.1.txt       |  4 +-
 2 files changed, 63 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..e8d65843
--- /dev/null
+++ b/Documentation/trace-cmd/trace-cmd-convert.1.txt
@@ -0,0 +1,60 @@ 
+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.
+*--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)

[v6,42/45] trace-cmd: Add convert man page

Commit Message

Patch