From 4c3aebea835bb02c3634221b3d9943ec48bb362f Mon Sep 17 00:00:00 2001 From: Rickard Green Date: Tue, 16 Feb 2010 22:59:48 +0000 Subject: OTP-8457 Minor documentation fixes. Mainly anchor adjustments. --- erts/doc/src/erlang.xml | 72 +++++++++++++++++-------------------------------- 1 file changed, 24 insertions(+), 48 deletions(-) (limited to 'erts/doc/src/erlang.xml') diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml index d4fd8c8c9f..46f8df4683 100644 --- a/erts/doc/src/erlang.xml +++ b/erts/doc/src/erlang.xml @@ -3474,9 +3474,8 @@ os_prompt%

This changes the minimum binary virtual heap size for the calling process.

- process_flag(priority, Level) + process_flag(priority, Level) -

This sets the process priority. Level is an atom. There are currently four priority levels: low, normal, high, and max. The default @@ -4788,9 +4787,8 @@ true ContextSwitches is the total number of context switches since the system started.

- exact_reductions + exact_reductions -

Returns {Total_Exact_Reductions, Exact_Reductions_Since_Last_Call}.

NOTE:statistics(exact_reductions) is @@ -4810,9 +4808,8 @@ true through ports, and Output is the total number of bytes output to ports.

- reductions + reductions -

Returns {Total_Reductions, Reductions_Since_Last_Call}.

NOTE: From erts version 5.5 (OTP release R11B) @@ -4983,9 +4980,8 @@ true

Sets the maximum depth of call stack back-traces in the exit reason element of 'EXIT' tuples.

- erlang:system_flag(cpu_topology, CpuTopology) + erlang:system_flag(cpu_topology, CpuTopology) -

Sets the user defined CpuTopology. The user defined CPU topology will override any automatically detected CPU topology. By passing undefined as CpuTopology @@ -5047,9 +5043,8 @@ true spawn_opt/N or process_flag/2.

- erlang:system_flag(multi_scheduling, BlockState) + erlang:system_flag(multi_scheduling, BlockState) -

BlockState = block | unblock

If multi-scheduling is enabled, more than one scheduler thread is used by the emulator. Multi-scheduling can be @@ -5083,9 +5078,8 @@ true erlang:system_info(multi_scheduling_blockers), and erlang:system_info(schedulers).

- erlang:system_flag(scheduler_bind_type, How) + erlang:system_flag(scheduler_bind_type, How) -

Controls if and how schedulers are bound to logical processors.

When erlang:system_flag(scheduler_bind_type, How) is @@ -5212,9 +5206,8 @@ true erlang:system_flag(cpu_topology, CpuTopology).

- erlang:system_flag(schedulers_online, SchedulersOnline) + erlang:system_flag(schedulers_online, SchedulersOnline) -

Sets the amount of schedulers online. Valid range is .

@@ -5252,9 +5245,8 @@ true

Returns various information about the current system (emulator) as specified by Type:

- allocated_areas + allocated_areas -

Returns a list of tuples with information about miscellaneous allocated memory areas.

Each tuple contains an atom describing type of memory as @@ -5274,9 +5266,8 @@ true in the total amount of memory allocated by the emulator see erlang:memory/0,1.

- allocator + allocator -

Returns {Allocator, Version, Features, Settings}.

Types:

@@ -5317,9 +5308,8 @@ true

See also "System Flags Effecting erts_alloc" in erts_alloc(3).

- alloc_util_allocators + alloc_util_allocators -

Returns a list of the names of all allocators using the ERTS internal alloc_util framework as atoms. For more information see the @@ -5328,9 +5318,8 @@ true erts_alloc(3) documentation.

- {allocator, Alloc} + {allocator, Alloc} -

Returns information about the specified allocator. As of erts version 5.6.1 the return value is a list of {instance, InstanceNo, InstanceInfo} tuples @@ -5366,9 +5355,8 @@ true values. The first value is memory pool size and the second value used memory size.

- {allocator_sizes, Alloc} + {allocator_sizes, Alloc} -

Returns various size information for the specified allocator. The information returned is a subset of the information returned by @@ -5402,9 +5390,8 @@ true line flag +R, see erl(1).

- cpu_topology + cpu_topology -

Returns the CpuTopology which currently is used by the emulator. The CPU topology is used when binding schedulers to logical processors. The CPU topology used is the user defined @@ -5677,9 +5664,8 @@ true erl(1) command for more information on modified timing.

- multi_scheduling + multi_scheduling -

Returns disabled, blocked, or enabled. A description of the return values:

@@ -5708,9 +5694,8 @@ true erlang:system_info(multi_scheduling_blockers), and erlang:system_info(schedulers).

- multi_scheduling_blockers + multi_scheduling_blockers -

Returns a list of PIDs when multi-scheduling is blocked; otherwise, the empty list. The PIDs in the list is PIDs of the processes currently @@ -5721,9 +5706,8 @@ true erlang:system_info(multi_scheduling), and erlang:system_info(schedulers).

- otp_release + otp_release -

Returns a string containing the OTP release number.

process_count @@ -5747,9 +5731,8 @@ true information see the "How to interpret the Erlang crash dumps" chapter in the ERTS User's Guide.

- scheduler_bind_type + scheduler_bind_type -

Returns information on how user has requested schedulers to be bound or not bound.

NOTE: Even though user has requested @@ -5764,9 +5747,8 @@ true erlang:system_info(scheduler_bindings).

- scheduler_bindings + scheduler_bindings -

Returns information on currently used scheduler bindings.

A tuple of a size equal to @@ -5788,18 +5770,16 @@ true erlang:system_info(schedulers_online).

- scheduler_id + scheduler_id -

Returns the scheduler id (SchedulerId) of the scheduler thread that the calling process is executing on. SchedulerId is a positive integer; where . See also erlang:system_info(schedulers).

- schedulers + schedulers -

Returns the number of scheduler threads used by the emulator. Scheduler threads online schedules Erlang processes and Erlang ports, and execute Erlang code @@ -5815,9 +5795,8 @@ true erlang:system_info(multi_scheduling), and and erlang:system_info(multi_scheduling_blockers).

- schedulers_online + schedulers_online -

Returns the amount of schedulers online. The scheduler identifiers of schedulers online satisfy the following relationship: @@ -5850,9 +5829,8 @@ true with thread support; otherwise, false is returned.

- thread_pool_size + thread_pool_size -

Returns the number of async threads in the async thread pool used for asynchronous driver calls (driver_async()) @@ -5865,9 +5843,8 @@ true get_tcw in "Match Specifications in Erlang", ERTS User's Guide.

- version + version -

Returns a string containing the version number of the emulator.

@@ -6477,9 +6454,8 @@ true the current function cannot be determined, then the last element Arity is 0.

- {trace, Pid, gc_start, Info} + {trace, Pid, gc_start, Info} -

Sent when garbage collection is about to be started. Info is a list of two-element tuples, where the first element is a key, and the second is the value. -- cgit v1.2.3