Add timestamp fwd ref to clock section
authorMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Fri, 31 May 2013 14:58:24 +0000 (10:58 -0400)
committerMathieu Desnoyers <mathieu.desnoyers@efficios.com>
Fri, 31 May 2013 14:58:24 +0000 (10:58 -0400)
And clarify clock text.

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
common-trace-format-specification.txt

index b40193f4377661144b092bbc343b280d7588cfa7..532094434798bce2376e0e621cf26281c3fd93c1 100644 (file)
@@ -717,6 +717,7 @@ Event packet context (all fields are optional, specified by TSDL meta-data):
   while (or before) writing the first event and while (or after) writing the
   last event in the packet. The inclusive range between these timestamps should
   include all event timestamps assigned to events contained within the packet.
+  See Section 8. Clocks for more detail.
 - Events discarded count
   - Snapshot of a per-stream free-running counter, counting the number of
     events discarded that were supposed to be written in the stream after
@@ -839,6 +840,8 @@ either:
 
   typealias integer { size = X; align = 1; signed = false; } := uintX_t;
 
+For more information about timestamp fields, see Section 8. Clocks.
+
 6.1.1 Type 1 - Few event IDs
 
   - Aligned on 32-bit (or 8-bit if byte-packed, depending on the architecture
@@ -1377,10 +1380,11 @@ stream {
 };
 
 For a N-bit integer type referring to a clock, if the integer overflows
-compared to the N low order bits of the clock prior value, then it is
-assumed that one, and only one, overflow occurred. It is therefore
-important that events encoding time on a small number of bits happen
-frequently enough to detect when more than one N-bit overflow occurs.
+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
+number of bits happen frequently enough to detect when more than one
+N-bit overflow occurs.
 
 In a packet context, clock field names ending with "_begin" and "_end"
 have a special meaning: this refers to the time-stamps at, respectively,
This page took 0.033369 seconds and 4 git commands to generate.