Correct the documentation of available timestamps 85/253485/1
authorMateusz Majewski <m.majewski2@samsung.com>
Thu, 11 Feb 2021 11:02:36 +0000 (12:02 +0100)
committerMateusz Majewski <m.majewski2@samsung.com>
Thu, 11 Feb 2021 11:02:36 +0000 (12:02 +0100)
Change-Id: I4457d59f082f80bf997cc464509a1e0c497657df

documentation/overview.rst

index f1c1b99..63d3057 100644 (file)
@@ -149,13 +149,16 @@ timestamps since they could potentially have to be compared against each other
 (see below: KMSG, Syslog and Android devices all use different timestamps, only
 pipe-based logs are flexible).
 
-Here's who imparts each type of timestamp (not counting Pipe, who does all):
-
-           │ Monotonic   │  Realtime
-───────────┼─────────────┼───────────────
-On send    │ KMSG        │ syslog
-───────────┼─────────────┼───────────────
-On receive │ -           │ Android Logger
+Here's what timestamp types are available from different log sources:
+
+- KMSG gets a sent-monotonic timestamp when log is sent, and the daemon adds
+  both receive timestamps.
+- syslog gets a sent-realtime timestamp when log is sent, and the daemon adds
+  both receive timestamps.
+- When Android Logger backend is enabled, all its buffers have only the
+  sent-realtime timestamp available.
+- When pipe backend is enabled, all its buffers have all four timestamps
+  available.
 
 Having four different timestamp configuratons inflicts quad damage upon our
 ability to compare such logs to each other. We are forced us to copy both