File 0317-erlang-module-doc-date-0-localtime-0-time-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0317-erlang-module-doc-date-0-localtime-0-time-0-and-univ.patch of Package erlang

From c89d891786d4eabae72fcb131798426c30d0db02 Mon Sep 17 00:00:00 2001
From: Kjell Winblad <kjellwinblad@gmail.com>
Date: Thu, 3 Sep 2020 10:43:35 +0200
Subject: [PATCH 17/39] erlang module doc: date/0, localtime/0, time/0 and
 universaltime/0

State that date/0, localtime/0, time/0 and universaltime/0 are based
on the OS System Time.
---
 erts/doc/src/erlang.xml | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 35a9543023..fc96ac3f43 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -1102,7 +1102,9 @@ Z = erlang:crc32_combine(X,Y,iolist_size(Data2)).</code>
       <desc>
         <p>Returns the current date as <c>{Year, Month, Day}</c>.</p>
         <p>The time zone and Daylight Saving Time correction depend on
-          the underlying OS. Example:</p>
+          the underlying OS. The return value is based on the <seeguide
+        marker="time_correction#os-system-time">OS System
+        Time</seeguide>. Example:</p>
         <pre>
 > <input>date().</input>
 {1995,2,19}</pre>
@@ -3164,8 +3166,10 @@ false</code>
         <pre>
 > <input>erlang:localtime().</input>
 {{1996,11,6},{14,45,17}}</pre>
-        <p>The time zone and Daylight Saving Time correction depend
-          on the underlying OS.</p>
+        <p>The time zone and Daylight Saving Time correction depend on
+        the underlying OS. The return value is based on the <seeguide
+        marker="time_correction#os-system-time">OS System
+        Time</seeguide>.</p>
       </desc>
     </func>
 
@@ -10491,7 +10495,9 @@ end</code>
       <desc>
         <p>Returns the current time as <c>{Hour, Minute, Second}</c>.</p>
         <p>The time zone and Daylight Saving Time correction depend on
-          the underlying OS. Example:</p>
+        the underlying OS. The return value is based on the <seeguide
+        marker="time_correction#os-system-time">OS System
+        Time</seeguide>. Example:</p>
         <pre>
 > <input>time().</input>
 {9,42,44}</pre>
@@ -12014,7 +12020,9 @@ improper_end</pre>
           <c>{{Year, Month, Day}, {Hour, Minute, Second}}</c> if
           supported by the underlying OS.
           Otherwise <c>erlang:universaltime()</c> is equivalent to
-          <c>erlang:localtime()</c>. Example:</p>
+          <c>erlang:localtime()</c>. The return value is based on the <seeguide
+        marker="time_correction#os-system-time">OS System
+        Time</seeguide>. Example:</p>
         <pre>
 > <input>erlang:universaltime().</input>
 {{1996,11,6},{14,18,43}}</pre>
-- 
2.26.2

Places

File 0317-erlang-module-doc-date-0-localtime-0-time-0-and-univ.patch of Package erlang

Places