From 858c6f7fa44f7b2dc363b359198d6522dd60e914 Mon Sep 17 00:00:00 2001
From: Rickard Green <rickard@erlang.org>
Date: Tue, 5 Jan 2016 16:55:04 +0100
Subject: Introduce time warp safe trace timestamp formats

New timestamp options for trace, sequential trace, and
system profile:
- monotonic_timestamp
- strict_monotonic_timestamp
---
 lib/kernel/doc/src/seq_trace.xml | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'lib/kernel/doc')

diff --git a/lib/kernel/doc/src/seq_trace.xml b/lib/kernel/doc/src/seq_trace.xml
index 3439111035..9f191d488d 100644
--- a/lib/kernel/doc/src/seq_trace.xml
+++ b/lib/kernel/doc/src/seq_trace.xml
@@ -127,6 +127,34 @@ seq_trace:set_token(OldToken), % activate the trace token again
               enables/disables a timestamp to be generated for each
               traced event. Default is <c>false</c>.</p>
           </item>
+          <tag><c>set_token(strict_monotonic_timestamp, <anno>Bool</anno>)</c></tag>
+          <item>
+            <p>A trace token flag (<c>true | false</c>) which
+            enables/disables a strict monotonic timestamp to be generated
+	    for each traced event. Default is <c>false</c>. Timestamps will
+	    consist of
+	    <seealso marker="erts:time_correction#Erlang_Monotonic_Time">Erlang
+	    monotonic time</seealso> and a monotonically increasing
+	    integer. The time-stamp has the same format and value
+	    as produced by <c>{erlang:monotonic_time(),
+	    erlang:unique_integer([monotonic])}</c>.</p>
+          </item>
+          <tag><c>set_token(monotonic_timestamp, <anno>Bool</anno>)</c></tag>
+          <item>
+            <p>A trace token flag (<c>true | false</c>) which
+            enables/disables a strict monotonic timestamp to be generated
+	    for each traced event. Default is <c>false</c>. Timestamps
+	    will use
+	    <seealso marker="erts:time_correction#Erlang_Monotonic_Time">Erlang
+	    monotonic time</seealso>. The time-stamp has the same
+	    format and value as produced by <c>erlang:monotonic_time()</c>.</p>
+          </item>
+	  <p>If multiple timestamp flags are passed, <c>timestamp</c> has
+	  precedence over <c>strict_monotonic_timestamp</c> which
+	  in turn has precedence over <c>monotonic_timestamp</c>. All
+	  timestamp flags are remembered, so if two are passed
+	  and the one with highest precedence later is disabled
+	  the other one will become active.</p>
         </taglist>
       </desc>
     </func>
-- 
cgit v1.2.3