From 606e660f898264ea75680532c076c56bbe855633 Mon Sep 17 00:00:00 2001 From: Lukas Larsson Date: Fri, 1 Jul 2016 17:32:51 +0200 Subject: erts: Review of documentation changes --- erts/doc/src/erlang.xml | 89 ++++++++++++++++++++++++------------------------- 1 file changed, 44 insertions(+), 45 deletions(-) (limited to 'erts/doc/src/erlang.xml') diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml index 3356447168..e402ce448f 100644 --- a/erts/doc/src/erlang.xml +++ b/erts/doc/src/erlang.xml @@ -147,7 +147,7 @@ as the native time unit. That is, it can differ between runtime restarts. To get values of this type, call - os:perf_counter().

+ os:perf_counter/0.

The time_unit/0 type can be extended. @@ -252,7 +252,7 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)). compile time, the call is better written as Fun(Arg1, Arg2, ... ArgN).

-

Earlier, Fun could also be speciifed as +

Earlier, Fun could also be specified as {Module, Function}, equivalent to apply(Module, Function, Args). This use is deprecated and will stop working in a future release.

@@ -352,7 +352,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.

+ stdlib:binary(3).

Allowed in guard tests.

@@ -643,13 +643,13 @@ Z = erlang:adler32_combine(X,Y,iolist_size(Data2)). is given.

-

When the operation is performed synchronously: +

When Async is false: if Info is true, the Result is returned by erlang:cancel_timer(). otherwise ok is returned.

 -

When the operation is performed asynchronously: +

When Async is true: if Info is true, a message on the form {cancel_timer, TimerRef, Result} is sent to the @@ -1928,7 +1928,7 @@ os_prompt% using proc_lib (also indirectly, such as gen_server processes), are to use - proc_lib:hibernate/3 in STDLIB + proc_lib:hibernate/3 instead, to ensure that the exception handler continues to work when the process wakes up.

@@ -2492,9 +2492,12 @@ os_prompt% implemented functions (NIFs) for a module. Path is a file path to the shareable object/dynamic library file minus the OS-dependent file extension (.so for Unix and - .dll for Windows). For information on how to + .dll for Windows). Notice that on most OSs the library has + to have a different name on disc when an upgrade of the nif is + done. If the name is the same, but the contents differ, the + old library may be loaded instead. For information on how to implement a NIF library, see - erl_nif.

+ erl_nif(3).

LoadInfo can be any term. It is passed on to the library as part of the initialization. A good practice is to include a module version number to support future code @@ -2689,8 +2692,7 @@ os_prompt%

This is a useful debugging and test tool, especially when writing complicated match specifications.

See also - ets:test_ms/2 - in STDLIB.

+ ets:test_ms/2.

@@ -2900,7 +2902,7 @@ RealSystem = system + MissedSystem

Returns the memory size in bytes allocated for memory of type - Type. The argument can also be specifed as a list + Type. The argument can also be specified as a list of memory_type() atoms, in which case a corresponding list of {memory_type(), Size :: integer >= 0} tuples is returned.

@@ -2987,7 +2989,7 @@ RealSystem = system + MissedSystem the monitored entity. Monitors are fired when the monitored process or port terminates, does not exist at the moment of creation, or if the connection to it is lost. If the connection to it is lost, - we do not know if it still exixts. The monitoring is also turned off + we do not know if it still exists. The monitoring is also turned off when demonitor/1 is called.

@@ -3063,7 +3065,7 @@ RealSystem = system + MissedSystem Monitoring a - time_offset + time_offset

Monitors changes in time offset @@ -3243,7 +3245,7 @@ RealSystem = system + MissedSystem - Stop execution with a specifed reason. + Stop execution with a specified reason.

Works exactly like error/1, but @@ -3333,9 +3335,7 @@ RealSystem = system + MissedSystem this garbage collection can be delayed. For more information, see - delayed_node_table_gc in - - erlang:system_info/1.

+ erlang:system_info(delayed_node_table_gc).

Some equalities: [node()] = nodes(this), @@ -3387,11 +3387,11 @@ 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, the + kernel:file(3), the function file:native_name_encoding/0 in Kernel, and - the STDLIB - User's Guide.

+ the + Using Unicode in Erlang User's Guide.

The characters in the name (if specified as a list) can only be > 255 if the Erlang virtual machine is started @@ -3544,7 +3544,7 @@ RealSystem = system + MissedSystem means that file wildcard expansion does not occur. To expand wildcards for the arguments, use - filelib:wildcard/1 in STDLIB. + filelib:wildcard/1. Notice that even if the program is a Unix shell script, meaning that the shell ultimately is invoked, wildcard expansion @@ -4404,10 +4404,10 @@ RealSystem = system + MissedSystem as code auto-loading depends on the correct operation of the error handling module.

Returns the old value of the flag.

- + Set process flag min_heap_size for the calling process. @@ -5884,7 +5884,7 @@ true

Sets the max_heap_size process flag. The default max_heap_size is determined by command-line argument +hmax - in erl/1. For more information, see the + in erl(1). For more information, see the documentation of process_flag(max_heap_size, Size).

@@ -5896,7 +5896,7 @@ true or on_heap. The default message_queue_data process flag is determined by command-line argument - +hmqd in erl/1. + +hmqd in erl(1). For more information, see the documentation of process_flag(message_queue_data, @@ -6128,7 +6128,7 @@ true type => scheduler}|...]

The time unit is the same as returned by - os:perf_counter/0 in Kernel. + os:perf_counter/0. So, to convert it to milliseconds, you can do something like this:

 lists:map(
@@ -6213,9 +6213,8 @@ lists:map(
             part of the other state.
         
         
The utility module
-          msacc in the
-          runtime_tools spplication can be used to more easily analyse
-          these statistics.

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

         
Returns undefined if system flag
           
           microstate_accounting is turned off.

@@ -6654,8 +6653,8 @@ ok
       Set system flag microstate_accounting.
       
         

-          Turns on/off microstate accounting measurements. By passing reset,
-          all counters can be reset to 0.

+          Turns on/off microstate accounting measurements. When passing reset,
+          all counters are reset to 0.

         
For more information see
           
           statistics(microstate_accounting).

@@ -6685,10 +6684,10 @@ ok
           processes. The size is specified in words.
           The new min_bin_vhheap_size effects only
           processes spawned after the change of
-          min_bin_vhheap_size has been made.
+          min_bin_vheap_size has been made.
           min_bin_vheap_size can be set for individual
           processes by using
-          spawn_opt/4 or
+          spawn_opt/2,3,4 or
           process_flag/2.

         
Returns the old value of the flag.

       
@@ -6705,7 +6704,7 @@ ok
           The size is specified in words. The new max_heap_size
           effects only processes spawned efter the change has been made.
           max_heap_size can be set for individual processes using
-          spawn_opt/4 or
+          spawn_opt/2,3,4 or
           
           process_flag/2.

         
Returns the old value of the flag.

@@ -7253,7 +7252,7 @@ ok
               changed by using
               
               erlang:system_flag/2.
-              spawn_opt/4
+              spawn_opt/2,3,4
               can spawn a process that does not use the default
               settings.

           
@@ -7266,7 +7265,7 @@ ok
               +hmax,
               +hmaxk and
               +hmaxel in
-              erl/1. It can also be changed at runtime using
+              erl(1). It can also be changed at runtime using
               
               erlang:system_flag(max_heap_size, MaxHeapSize).
               For more details about the max_heap_size process flag,
@@ -7286,7 +7285,7 @@ ok
               process flag, which is either off_heap or on_heap.
               This default is set by command-line argument
               +hmqd in
-              erl/1. For more information on the
+              erl(1). For more information on the
               message_queue_data process flag, see documentation of
               
               process_flag(message_queue_data, MQD).

@@ -7434,7 +7433,7 @@ ok
               of an entry in a node table is delayed. This limit can be set
               on startup by passing command-line flag
               +zdntgc
-              to erl/1. For more information, see the documentation of
+              to erl(1). For more information, see the documentation of
               the command-line flag.

           
           dirty_cpu_schedulers
@@ -7537,7 +7536,7 @@ ok
               in bytes. This limit can be set at startup by passing
               command-line flag
               +zdbbl
-              to erl.

+              to erl(1).

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

           
@@ -7602,7 +7601,7 @@ ok
           
             
Returns the value of command-line flag
               +secio in
-              erl/1, which is either true or false.
+              erl(1), which is either true or false.
               For information about the different values, see the
               documentation of the command-line flag.

           
@@ -8106,7 +8105,7 @@ ok
             
Returns the number of async threads in the async thread
               pool used for asynchronous driver calls
               (
-              driver_async()).
+              erl_driver:driver_async()).
               The value is given as an integer.

           
           time_correction
@@ -8492,8 +8491,8 @@ ok
           
         
         
-          
erlang:system_profile is considered experimental
-            and its behavior can change in a future release.

+          
erlang:system_profile behavior can change
+            in a future release.

         
       
     
@@ -9043,7 +9042,7 @@ timestamp() ->
               instead of sending a trace message. The tracer module
               can then ignore or change the trace message. For more details
               on how to write a tracer module, see
-              erl_tracer.

+              erl_tracer(3).

           
         
         
If no tracer is specified, the calling process
@@ -9400,7 +9399,7 @@ timestamp() ->
       
         
The delivery of trace messages (generated by
           erlang:trace/3,
-          kernel:seq_trace,
+          kernel:seq_trace(3),
           or 
           erlang:system_profile/2)
           is dislocated on the time-line
-- 
cgit v1.2.3