From 052695858c07477db480d25d2d858540088d04c3 Mon Sep 17 00:00:00 2001
From: Rickard Green
Date: Tue, 24 Mar 2015 10:27:20 +0100
Subject: Documentation adjustments
---
erts/doc/src/erlang.xml | 33 ++++++++++++++++++++++-----------
erts/doc/src/time_correction.xml | 29 +++++++++++++++++++++++++++--
2 files changed, 49 insertions(+), 13 deletions(-)
(limited to 'erts')
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 98c0ef5f81..7cb417ac92 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -110,10 +110,17 @@
The value of the native time unit gives
you more or less no information at all about the
- quality of time values. It sets an upper bound for
- the resolution as well as for the precision, but it
- gives absolutely no information at all about the
- accuracy.
+ quality of time values. It sets a limit for
+ the
+ resolution
+ as well as for the
+ precision
+ of time values,
+ but it gives absolutely no information at all about the
+ accuracy
+ of time values. The resolution of the native time
+ unit and the resolution of time values may differ
+ significantly.
@@ -6435,18 +6442,22 @@ ok
Function.
{resolution, OsMonotonicTimeResolution}
- Highest possible resolution of current
- OS monotonic time source as parts per second. If
- no resolution information can be retreived from
- the OS, OsMonotonicTimeResolution will be
+ Highest possible
+ resolution
+ of current OS monotonic time source as parts per
+ second. If no resolution information can be retreived
+ from the OS, OsMonotonicTimeResolution will be
set to the resolution of the time unit of
Functions return value. That is, the actual
resolution may be lower than
OsMonotonicTimeResolution. Also note that
the resolution does not say anything about the
- accuracy, and that the precision might not align
- with the resolution. You do, however, know that the
- precision won't be higher than
+ accuracy,
+ and that the
+ precision
+ might not align with the resolution. You do,
+ however, know that the precision won't be
+ better than
OsMonotonicTimeResolution.
{extended, Extended}
diff --git a/erts/doc/src/time_correction.xml b/erts/doc/src/time_correction.xml
index 3bc3d04186..ed658ff58c 100644
--- a/erts/doc/src/time_correction.xml
+++ b/erts/doc/src/time_correction.xml
@@ -114,6 +114,29 @@
happened yet), POSIX time would make a one second leap forward.
+
+
+ Time Resolution
+ The shortest time interval that can be distinguished when
+ reading time values.
+
+
+
+
+ Time Precision
+ The shortest time interval that can be be distinguished
+ repeatedly and reliably when reading time values. Precision
+ is limited by the
+ resolution, but
+ resolution and precision might differ significantly.
+
+
+
+
+ Time Accuracy
+ The correctness of time values.
+
+
OS System Time
@@ -162,8 +185,10 @@
Erlang runtime system. The Erlang monotonic time increase since
some unspecified point in time. It can be retrieved by calling
erlang:monotonic_time().
- The accuracy, and precision of Erlang monotonic time heavily
- depends on the accuracy and precision of
+ The
+ accuracy, and
+ precision of Erlang
+ monotonic time heavily depends on the accuracy and precision of
OS monotonic time,
the accuracy and precision of
OS system time as well
--
cgit v1.2.3