From ad6e765bcd4f35a282ef00e38ed9129f3a5c1d83 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Thu, 1 Sep 2016 14:32:27 +0200 Subject: doc: Correct errors introduced by Editorial changes Fix some older errors as well. --- erts/doc/src/erlang.xml | 86 ++++++++++++++++++++++++------------------------- 1 file changed, 43 insertions(+), 43 deletions(-) (limited to 'erts/doc/src/erlang.xml') diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml index 18f1b2e833..d0a3a77e43 100644 --- a/erts/doc/src/erlang.xml +++ b/erts/doc/src/erlang.xml @@ -377,7 +377,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)). 2> binary_part(Bin,{0,2}). <<1,2>>

For details about the PosLen semantics, see - stdlib:binary(3).

+ binary(3).

Allowed in guard tests.

@@ -504,7 +504,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)). this function is deprecated. New code is to use binary:bin_to_list/3 - in STDLIB instead. All functions in module + in STDLIB instead. All functions in module binary consistently use zero-based indexing.

@@ -724,7 +724,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)).

Returns true if Module has old code, otherwise false.

See also - kernel:code(3).

+ code(3).

@@ -825,7 +825,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)).

See also - kernel:code(3).

+ code(3).

Failures:

badarg @@ -1051,7 +1051,7 @@ Z = erlang:crc32_combine(X,Y,iolist_size(Data2)). otherwise true.

This BIF is intended for the code server (see - kernel:code(3)) + code(3)) and is not to be used elsewhere.

Failure: badarg if there already is an old version of @@ -2519,7 +2519,7 @@ os_prompt%

This BIF is intended for the code server (see - kernel:code(3)) + code(3)) and is not to be used elsewhere.

@@ -2584,7 +2584,7 @@ os_prompt%

Returns a list of all loaded Erlang modules (current and old code), including preloaded modules.

See also - kernel:code(3).

+ code(3).

@@ -2864,7 +2864,7 @@ os_prompt% ets -

The total amount of memory currently allocated for ets +

The total amount of memory currently allocated for ETS tables. This memory is part of the memory presented as system memory.

 @@ -2885,7 +2885,7 @@ os_prompt%

For information on how to run the emulator with instrumentation, see - tools:instrument(3) + instrument(3) and/or erl(1).

 @@ -2933,7 +2933,7 @@ RealSystem = system + MissedSystem memory blocks.

-

As from ERTS 5.6.4, erlang:memory/0 requires that +

As from ERTS 5.6.4, erlang:memory/0 requires that all erts_alloc(3) allocators are enabled (default behavior).

 @@ -2954,7 +2954,7 @@ RealSystem = system + MissedSystem of memory_type() atoms, in which case a corresponding list of {memory_type(), Size :: integer >= 0} tuples is returned.

-

As from ERTS 5.6.4, +

As from ERTS 5.6.4, erlang:memory/1 requires that all erts_alloc(3) allocators are enabled (default behavior).

@@ -3002,7 +3002,7 @@ RealSystem = system + MissedSystem the module.

This BIF is intended for the code server (see - kernel:code(3)) + code(3)) and is not to be used elsewhere.

 @@ -3225,13 +3225,13 @@ RealSystem = system + MissedSystem time-out for the monitored node to connect itself, even if it cannot be actively connected from this node (that is, it is blocked). The state where this can be useful - can only be achieved by using the Kernel option + can only be achieved by using the Kernel option dist_auto_connect once. If that option is not used, option allow_passive_connect has no effect.

Option allow_passive_connect is used internally and is seldom needed in applications where the - network topology and the Kernel options in effect + network topology and the Kernel options in effect are known in advance.

Failure: badarg if the local node is not alive or the @@ -3297,9 +3297,9 @@ RealSystem = system + MissedSystem

Works exactly like error/1, but - Dialyzer thinks that this BIF will return an arbitrary + Dialyzer thinks that this BIF will return an arbitrary term. When used in a stub function for a NIF to generate an - exception when the NIF library is not loaded, Dialyzer + exception when the NIF library is not loaded, Dialyzer does not generate false warnings.

@@ -3310,9 +3310,9 @@ RealSystem = system + MissedSystem

Works exactly like error/2, but - Dialyzer thinks that this BIF will return an arbitrary + Dialyzer thinks that this BIF will return an arbitrary term. When used in a stub function for a NIF to generate an - exception when the NIF library is not loaded, Dialyzer + exception when the NIF library is not loaded, Dialyzer does not generate false warnings.

 @@ -3435,9 +3435,9 @@ RealSystem = system + MissedSystem translation or to force, for example UTF-8, supply the executable and/or arguments as a binary in the correct encoding. For details, see the module - kernel:file(3), the + file(3), the function - file:native_name_encoding/0 in Kernel, and + file:native_name_encoding/0 in Kernel, and the Using Unicode in Erlang User's Guide.

@@ -3749,7 +3749,7 @@ RealSystem = system + MissedSystem the owning process using signals of the form {'EXIT', Port, PosixCode}. For the possible values of PosixCode, see - kernel:file(3).

+ file(3).

The maximum number of ports that can be open at the same time can be configured by passing command-line flag +Q to @@ -3764,7 +3764,7 @@ RealSystem = system + MissedSystem

Portable hash function that gives the same hash for the same Erlang term regardless of machine architecture and - ERTS version (the BIF was introduced in ERTS 4.9.1.1). + ERTS version (the BIF was introduced in ERTS 4.9.1.1). The function returns a hash value for Term within the range 1..Range. The maximum value for @@ -3784,7 +3784,7 @@ RealSystem = system + MissedSystem

Portable hash function that gives the same hash for the same Erlang term regardless of machine architecture and - ERTS version (the BIF was introduced in ERTS 5.2). + ERTS version (the BIF was introduced in ERTS 5.2). The function returns a hash value for Term within the range 0..Range-1. The maximum value for @@ -4347,7 +4347,7 @@ RealSystem = system + MissedSystem Information about the queue size of a port.

Bytes is the total number - of bytes queued by the port using the ERTS driver queue + of bytes queued by the port using the ERTS driver queue implementation.

If the port identified by Port is not open, undefined is returned. If the port is closed and the @@ -4573,7 +4573,7 @@ RealSystem = system + MissedSystem

All messages in the message queue will eventually be placed on heap. They can however temporarily be stored off heap. This is how messages always have been stored - up until ERTS 8.0.

+ up until ERTS 8.0.

The default message_queue_data process flag is determined @@ -5153,11 +5153,11 @@ RealSystem = system + MissedSystem that no processes execute old code in the module.

This BIF is intended for the code server (see - kernel:code(3)) + code(3)) and is not to be used elsewhere.

 -

As from ERTS 8.0 (Erlang/OTP 19), any lingering processes +

As from ERTS 8.0 (Erlang/OTP 19), any lingering processes that still execute the old code is killed by this function. In earlier versions, such incorrect use could cause much more fatal failures, like emulator crash.

@@ -6056,7 +6056,7 @@ true

If Dest is a pid(), the timer is automatically canceled if the process referred to by the pid() is not alive, or if the process exits. This - feature was introduced in ERTS 5.4.11. Notice that + feature was introduced in ERTS 5.4.11. Notice that timers are not automatically canceled when Dest is an atom().

See also @@ -6157,7 +6157,7 @@ true system flag microstate_accounting.

statistics(microstate_accounting) returns a list of maps - representing some of the OS threads within ERTS. Each map + representing some of the OS threads within ERTS. Each map contains type and id fields that can be used to identify what thread it is, and also a counters field that contains data about how @@ -6249,7 +6249,7 @@ lists:map( scheduler_wall_time fraction. Without extra states this time is part of the other state. ets - Time spent executing ets BIFs. Without extra states + Time spent executing ETS BIFs. Without extra states this time is part of the emulator state. gc_full Time spent doing fullsweep garbage collection. Without extra @@ -6265,7 +6265,7 @@ lists:map( part of the other state.

The utility module - runtime_tools:msacc(3) + msacc(3) can be used to more easily analyse these statistics.

Returns undefined if system flag @@ -6288,7 +6288,7 @@ lists:map( 

 > statistics(reductions).
 {2046,11}
-

As from ERTS 5.5 (Erlang/OTP R11B), +

As from ERTS 5.5 (Erlang/OTP R11B), this value does not include reductions performed in current time slices of currently scheduled processes. If an exact value is wanted, use @@ -7107,7 +7107,7 @@ ok

Returns a list of the names of all allocators using - the ERTS internal alloc_util framework + the ERTS internal alloc_util framework as atoms. For more information, see section The alloc_util framework @@ -7117,7 +7117,7 @@ ok

Returns information about the specified allocator. - As from ERTS 5.6.1, the return value is a list + As from ERTS 5.6.1, the return value is a list of {instance, InstanceNo, InstanceInfo} tuples, where InstanceInfo contains information about a specific instance of the allocator. @@ -7134,8 +7134,8 @@ ok

The recognized allocators are listed in erts_alloc(3). Information about super carriers can be obtained from - ERTS 8.0 with {allocator, erts_mmap} or from - ERTS 5.10.4; the returned list when calling with + ERTS 8.0 with {allocator, erts_mmap} or from + ERTS 5.10.4; the returned list when calling with {allocator, mseg_alloc} also includes an {erts_mmap, _} tuple as one element in the list.

After reading the erts_alloc(3) documentation, @@ -7619,7 +7619,7 @@ ok (for example, ./configure --with-dynamic-trace=dtrace). For more information about dynamic tracing, see - runtime_tools:dyntrace(3) manual page and the + dyntrace(3) manual page and the README.dtrace/README.systemtap files in the Erlang source code top directory.

@@ -7659,7 +7659,7 @@ ok ets_limit -

Returns the maximum number of ets tables allowed. This +

Returns the maximum number of ETS tables allowed. This limit can be increased at startup by passing command-line flag +e to @@ -7847,7 +7847,7 @@ ok

Returns a string containing the OTP release number of the - OTP release that the currently executing ERTS application + OTP release that the currently executing ERTS application is part of.

As from Erlang/OTP 17, the OTP release number corresponds to the major OTP version number. No @@ -8222,7 +8222,7 @@ ok tolerant_timeofday -

Returns whether a pre ERTS 7.0 backwards compatible +

Returns whether a pre ERTS 7.0 backwards compatible compensation for sudden changes of system time is enabled or disabled. Such compensation is enabled when the time offset @@ -8290,8 +8290,8 @@ ok

Argument scheduler has changed name to scheduler_id to avoid mix up with argument schedulers. Argument scheduler was - introduced in ERTS 5.5 and renamed in - ERTS 5.5.1.

+ introduced in ERTS 5.5 and renamed in + ERTS 5.5.1.

 @@ -9451,7 +9451,7 @@ timestamp() ->

The delivery of trace messages (generated by erlang:trace/3, - kernel:seq_trace(3), + seq_trace(3), or erlang:system_profile/2) is dislocated on the time-line -- cgit v1.2.3