aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc/src
diff options
context:
space:
mode:
authorRickard Green <rickard@erlang.org>2016-08-24 11:46:34 +0200
committerRickard Green <rickard@erlang.org>2016-08-25 17:33:05 +0200
commit412b5aaa5810cbac75ef41d29a36898ff1480129 (patch)
treedab5f9e78e8df4e894c56b7cf2c1335a50759bab /erts/doc/src
parent71894a879d6254693791585246ce340dd7414b82 (diff)
downloadotp-412b5aaa5810cbac75ef41d29a36898ff1480129.tar.gz
otp-412b5aaa5810cbac75ef41d29a36898ff1480129.tar.bz2
otp-412b5aaa5810cbac75ef41d29a36898ff1480129.zip
Replace misspelled symbolic time units
Besides using two words for 'milliseconds' et. al. they are also changed from plural to singular.
Diffstat (limited to 'erts/doc/src')
-rw-r--r--erts/doc/src/erlang.xml53
1 files changed, 39 insertions, 14 deletions
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 6289f033b2..e06ad461d8 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -70,26 +70,26 @@
</datatype>
<datatype>
<name name="time_unit"></name>
- <desc><p><marker id="type_time_unit"/>
- Supported time unit representations:</p>
+ <desc><marker id="type_time_unit"/>
+ <p>Supported time unit representations:</p>
<taglist>
<tag><c>PartsPerSecond :: integer() >= 1</c></tag>
<item><p>Time unit expressed in parts per second. That is,
the time unit equals <c>1/PartsPerSecond</c> second.</p></item>
- <tag><c>seconds</c></tag>
+ <tag><c>second</c></tag>
<item><p>Symbolic representation of the time unit
represented by the integer <c>1</c>.</p></item>
- <tag><c>milli_seconds</c></tag>
+ <tag><c>millisecond</c></tag>
<item><p>Symbolic representation of the time unit
represented by the integer <c>1000</c>.</p></item>
- <tag><c>micro_seconds</c></tag>
+ <tag><c>microsecond</c></tag>
<item><p>Symbolic representation of the time unit
represented by the integer <c>1000000</c>.</p></item>
- <tag><c>nano_seconds</c></tag>
+ <tag><c>nanosecond</c></tag>
<item><p>Symbolic representation of the time unit
represented by the integer <c>1000000000</c>.</p></item>
@@ -108,7 +108,7 @@
<p>One can get an approximation of the <c>native</c>
time unit by calling <c>erlang:convert_time_unit(1,
- seconds, native)</c>. The result equals the number
+ second, native)</c>. The result equals the number
of whole <c>native</c> time units per second. In case
the number of <c>native</c> time units per second does
not add up to a whole number, the result is rounded downwards.</p>
@@ -138,8 +138,12 @@
as the <c>native</c> time unit. That is it might differ inbetween
run-time restarts. You get values of this type by calling
<seealso marker="kernel:os#perf_counter/0"><c>os:perf_counter()</c></seealso>
- </p>
- </item>
+ </p></item>
+
+ <tag><seealso marker="#type_deprecated_time_unit"><c>deprecated_time_unit()</c></seealso></tag>
+ <item><p>
+ Deprecated symbolic representations kept for backwards-compatibility.
+ </p></item>
</taglist>
@@ -149,6 +153,27 @@
</desc>
</datatype>
+ <datatype>
+ <name name="deprecated_time_unit"></name>
+ <desc><marker id="type_deprecated_time_unit"/>
+ <p>The <seealso marker="#type_time_unit"><c>time_unit()</c></seealso>
+ type also consist of the following <em>deprecated</em> symbolic
+ time units:</p>
+ <taglist>
+ <tag><c>seconds</c></tag>
+ <item><p>Same as <seealso marker="#type_time_unit"><c>second</c></seealso>.</p></item>
+
+ <tag><c>milli_seconds</c></tag>
+ <item><p>Same as <seealso marker="#type_time_unit"><c>millisecond</c></seealso>.</p></item>
+
+ <tag><c>micro_seconds</c></tag>
+ <item><p>Same as <seealso marker="#type_time_unit"><c>microsecond</c></seealso>.</p></item>
+
+ <tag><c>nano_seconds</c></tag>
+ <item><p>Same as <seealso marker="#type_time_unit"><c>nanosecond</c></seealso>.</p></item>
+ </taglist>
+ </desc>
+ </datatype>
</datatypes>
<funcs>
@@ -8284,7 +8309,7 @@ ok
<seealso marker="time_correction#Erlang_Monotonic_Time">Erlang
monotonic time</seealso>. The time-stamp (Ts) has the same
format and value as produced by
- <c>erlang:monotonic_time(nano_seconds)</c>.</p>
+ <c>erlang:monotonic_time(nanosecond)</c>.</p>
</item>
<tag><c>runnable_procs</c></tag>
<item>
@@ -8312,7 +8337,7 @@ ok
<seealso marker="time_correction#Erlang_Monotonic_Time">Erlang
monotonic time</seealso> and a monotonically increasing
integer. The time-stamp (Ts) has the same format and value
- as produced by <c>{erlang:monotonic_time(nano_seconds),
+ as produced by <c>{erlang:monotonic_time(nanosecond),
erlang:unique_integer([monotonic])}</c>.</p>
</item>
<tag><c>timestamp</c></tag>
@@ -8525,7 +8550,7 @@ ok
<p>The <c>erlang:timestamp()</c> BIF is equivalent to:</p><code type="none">
timestamp() ->
- ErlangSystemTime = erlang:system_time(micro_seconds),
+ ErlangSystemTime = erlang:system_time(microsecond),
MegaSecs = ErlangSystemTime div 1000000000000,
Secs = ErlangSystemTime div 1000000 - MegaSecs*1000000,
MicroSecs = ErlangSystemTime rem 1000000,
@@ -8762,7 +8787,7 @@ timestamp() ->
<seealso marker="time_correction#Erlang_Monotonic_Time">Erlang
monotonic time</seealso> time-stamp in all trace messages. The
time-stamp (Ts) has the same format and value as produced by
- <seealso marker="#monotonic_time-1"><c>erlang:monotonic_time(nano_seconds)</c></seealso>.
+ <seealso marker="#monotonic_time-1"><c>erlang:monotonic_time(nanosecond)</c></seealso>.
This flag overrides the <c>cpu_timestamp</c> flag.</p>
</item>
<tag><c>strict_monotonic_timestamp</c></tag>
@@ -8772,7 +8797,7 @@ timestamp() ->
monotonic time</seealso> and a monotonically increasing
integer in all trace messages. The time-stamp (Ts) has the
same format and value as produced by
- <c>{</c><seealso marker="#monotonic_time-1"><c>erlang:monotonic_time(nano_seconds)</c></seealso><c>,</c>
+ <c>{</c><seealso marker="#monotonic_time-1"><c>erlang:monotonic_time(nanosecond)</c></seealso><c>,</c>
<seealso marker="#unique_integer-1"><c>erlang:unique_integer([monotonic])</c></seealso><c>}</c>.
This flag overrides the <c>cpu_timestamp</c> flag.</p>
</item>