From dc8e62f33ad0ca7a772ec74d67b6d3e157f639b4 Mon Sep 17 00:00:00 2001
From: Rickard Green <rickard@erlang.org>
Date: Wed, 13 Jan 2016 18:33:42 +0100
Subject: Introduce time warp safe replacement for safe_fixed option

The new time warp safe option is safe_fixed_monotonic_time which
gives erlang:monotonic_time().

The safe_fixed option was also slightly changed. It now gives
erlang:timestamp() instead of erlang:now(). This has however
not been documented, so it is considered a compatible change.

The above effects both ets, and dets.

This commit also include the bugfix OTP-13239 for
dets:info(Tab, safe_fixed). The timestamp in the result returned
by dets:info(Tab, safe_fixed) was unintentionally broken as a
result of the time API rewrites in OTP 18.0.
---
 lib/stdlib/doc/src/dets.xml | 31 ++++++++++++++++++++++++++++---
 1 file changed, 28 insertions(+), 3 deletions(-)

(limited to 'lib/stdlib/doc/src/dets.xml')

diff --git a/lib/stdlib/doc/src/dets.xml b/lib/stdlib/doc/src/dets.xml
index a0d3f95b6a..48400733d1 100644
--- a/lib/stdlib/doc/src/dets.xml
+++ b/lib/stdlib/doc/src/dets.xml
@@ -399,15 +399,40 @@
               kept in RAM.</p>
           </item>
           <item>
-            <p><c>{safe_fixed,</c> SafeFixed<c>}</c>. If the table
-              is fixed, SafeFixed is a tuple <c>{FixedAtTime, [{Pid,RefCount}]}</c>. <c>FixedAtTime</c> is the time when
+            <p><c>{safe_fixed_monotonic_time, SafeFixed}</c>. If the table
+              is fixed, <c>SafeFixed</c> is a tuple <c>{FixedAtTime, [{Pid,RefCount}]}</c>.
+	      <c>FixedAtTime</c> is the time when
               the table was first fixed, and <c>Pid</c> is the pid of
               the process that fixes the table <c>RefCount</c> times.
               There may be any number of processes in the list. If the
               table is not fixed, SafeFixed is the atom <c>false</c>.</p>
+	      <p><c>FixedAtTime</c> will correspond to the result
+	      returned by
+	      <seealso marker="erts:erlang#monotonic_time/0">erlang:monotonic_time/0</seealso>
+	      at the time of fixation. The usage of <c>safe_fixed_monotonic_time</c> is
+	      <seealso marker="erts:time_correction#Time_Warp_Safe_Code">time warp
+	      safe</seealso>.</p>
           </item>
           <item>
-            <p><c>{version, integer()</c>, the version of the format of
+            <p>
+	      <c>{safe_fixed, SafeFixed}</c>. The same as
+	      <c>{safe_fixed_monotonic_time, SafeFixed}</c> with the exception
+	      of the format and value of <c>FixedAtTime</c>.
+	    </p>
+	    <p>
+	      <c>FixedAtTime</c> will correspond to the result returned by
+	      <seealso marker="erts:erlang#timestamp/0">erlang:timestamp/0</seealso>
+	      at the time of fixation. Note that when the system is using
+	      single or multi
+	      <seealso marker="erts:time_correction#Time_Warp_Modes">time warp
+	      modes</seealso> this might produce strange results. This
+	      since the usage of <c>safe_fixed</c> is not
+	      <seealso marker="erts:time_correction#Time_Warp_Safe_Code">time warp
+	      safe</seealso>. Time warp safe code need to use
+	      <c>safe_fixed_monotonic_time</c> instead.</p>
+          </item>
+          <item>
+            <p><c>{version, integer()}</c>, the version of the format of
               the table.</p>
           </item>
         </list>
-- 
cgit v1.2.3