summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>2019-07-17 13:59:51 +0700
committerSaya Sugiura <39760799+ssugiura@users.noreply.github.com>2019-09-13 08:48:31 +0900
commitb1193fa1f3b48587666202f513d9bfba719fdc6a (patch)
tree0251bd4fd27ad5eeb6d615035fef8ce686e0726a /doc
parentd973560abe98290a215c2a23915620b6beecf2c1 (diff)
downloadDLT-daemon-b1193fa1f3b48587666202f513d9bfba719fdc6a.tar.gz
console: Tool to merge multiple DLT files
- Sort in dlt-sortbytimestamp: first sorted by time, second sorted by timestamp. - Support multiple compressed files in dlt-convert. These changes is based on use case: User can expects to join several dlt files which are compressed in tar.gz file (maybe per component). Moreover, currently the existing sort is only applicaple for single boot cycle. There should be a support for sorting multiple cyclic boots in one dlt file. Signed-off-by: Bui Nguyen Quoc Thanh <Thanh.BuiNguyenQuoc@vn.bosch.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/dlt-convert.1.md11
-rw-r--r--doc/dlt-sortbytimestamp.1.md10
2 files changed, 13 insertions, 8 deletions
diff --git a/doc/dlt-convert.1.md b/doc/dlt-convert.1.md
index c0df353..19f855a 100644
--- a/doc/dlt-convert.1.md
+++ b/doc/dlt-convert.1.md
@@ -6,7 +6,7 @@
# SYNOPSIS
-**dlt-convert** \[**-h**\] \[**-a**\] \[**-x**\] \[**-m**\] \[**-s**\] \[**-o** filename\] \[**-v**\] \[**-c**\] \[**-f** filterfile\] \[**-b** number\] \[**-e** number\] \[**-w**\] file1 \[file2\] \[file3\]
+**dlt-convert** \[**-h**\] \[**-a**\] \[**-x**\] \[**-m**\] \[**-s**\] \[**-t**\] \[**-o** filename\] \[**-v**\] \[**-c**\] \[**-f** filterfile\] \[**-b** number\] \[**-e** number\] \[**-w**\] file1 \[file2\] \[file3\]
# DESCRIPTION
@@ -63,6 +63,10 @@ Use two files and Output file to join DLT files.
: Follow dlt file while file is increasing.
+-t
+
+: Handling the compressed input files (tar.gz).
+
# EXAMPLES
Convert DLT file into ASCII:
@@ -71,9 +75,12 @@ Convert DLT file into ASCII:
Cut a specific range, e.g. from message 1 to message 3 from a file called log.dlt and store the result to a file called newlog.dlt:
**dlt-convert -b 1 -e 3 -o newlog.dlt log.dlt**
-Paste two dlt files log1.dlt and log2.dlt to a new file called newlog.dlt::
+Paste two dlt files log1.dlt and log2.dlt to a new file called newlog.dlt:
**dlt-convert -o newlog.dlt log1.dlt log2.dlt**
+Handle the compressed input files and join inputs into a new file called newlog.dlt:
+ **dlt-convert -t -o newlog.dlt log1.dlt compressed_log2.tar.gz**
+
# EXIT STATUS
Non zero is returned in case of failure.
diff --git a/doc/dlt-sortbytimestamp.1.md b/doc/dlt-sortbytimestamp.1.md
index 9f66320..caf0256 100644
--- a/doc/dlt-sortbytimestamp.1.md
+++ b/doc/dlt-sortbytimestamp.1.md
@@ -2,7 +2,7 @@
# NAME
-**dlt-sortbytimestamp** - Re-order DLT Logging files according to message creation time
+**dlt-sortbytimestamp** - Re-order DLT Logging files according to message creation time and timestamp.
# SYNOPSIS
@@ -12,13 +12,11 @@
By default messages in DLT files are ordered according to the time the logger received them. This can unhelpful when tracing a sequence of events on a busy multi-threaded/multi-core system, because thread pre-emption combined with multiple processes attempting to log messages simultaneously means that the order in which the messages are received may vary significantly from the order in which they were created.
-*dlt-sortbytimestamp* re-orders a DLT input file's messages according their creation timestamp, and writes them to an output DLT file.
+*dlt-sortbytimestamp* is able to re-order a DLT input file's messages according both their creation time and timestamp, and writes them to an output DLT file.
-# IMPORTANT NOTE
+# NOTE
-Message timestamps are recorded relative to boot time. DLT files can contain messages from more than one reboot cycle. Because timestamping is reset to zero at each boot, simply running *dlt-sortbytimestamp* against a multi-boot-cycle DLT input file will produce a tangled mess.
-
-Use the *-b* and/or *-e* options to specify a range of messages within a single reboot cycle and all will be well.
+Use the \*-b\* and/or \*-e\* options to specify a range of messages within a single reboot cycle and all will be well.
Hint: use *dlt-viewer* to ascertain the endpoints of the range in question.