diff mbox series

[RFC,CTF,3/3] Clarify that timestamp begin/end need to be complete clock values

Message ID 20200423205226.496-4-mathieu.desnoyers@efficios.com
State Superseded, archived
Headers show
Series Common Trace Format Updates (upcoming 1.8.3) | expand

Commit Message

Mathieu Desnoyers April 23, 2020, 8:52 p.m. UTC
Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers at efficios.com>
---
 common-trace-format-specification.md | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/common-trace-format-specification.md b/common-trace-format-specification.md
index 53b70f4..7681ce5 100644
--- a/common-trace-format-specification.md
+++ b/common-trace-format-specification.md
@@ -1580,7 +1580,8 @@  stream {
 };
 ~~~
 
-For a N-bit integer type referring to a clock, if the integer overflows
+Within the stream event context, event context, and event payload,
+fields of N-bit integer type referring to a clock, if the integer overflows
 compared to the N low order bits of the clock prior value found in the
 same stream, then it is assumed that one, and only one, overflow
 occurred. It is therefore important that events encoding time on a small
@@ -1589,8 +1590,8 @@  N-bit overflow occurs.
 
 In a packet context, clock field names ending with `_begin` and `_end`
 have a special meaning: this refers to the timestamps at, respectively,
-the beginning and the end of each packet.
-
+the beginning and the end of each packet. Those are required to be
+complete representations of the clock value.
 
 ## A. Helper macros