From 7b5ca88b32c22a7f1a3152265d8d73418013b1c0 Mon Sep 17 00:00:00 2001
From: Lukas Larsson
Date: Fri, 13 May 2016 10:38:20 +0200
Subject: erts: Fix doc xml errors
---
erts/doc/src/erl.xml | 11 +-
erts/doc/src/erl_driver.xml | 4 +-
erts/doc/src/erl_nif.xml | 26 ++---
erts/doc/src/erlang.xml | 242 ++++++++++++++++++++++----------------------
4 files changed, 143 insertions(+), 140 deletions(-)
diff --git a/erts/doc/src/erl.xml b/erts/doc/src/erl.xml
index 5d5bfb141f..7b90a1ccca 100644
--- a/erts/doc/src/erl.xml
+++ b/erts/doc/src/erl.xml
@@ -643,8 +643,7 @@
Sets the default binary virtual heap size of processes to the size
.
-
-
+
-
Sets the default maximum heap size of processes to the size
. If +hmax is not given, the default is 0
@@ -653,8 +652,7 @@
process_flag(max_heap_size, MaxHeapSize).
-
-
+
-
Sets whether to send an error logger message for processes that reach
the maximum heap size or not. If +hmaxel is not given, the default is true.
@@ -662,8 +660,7 @@
process_flag(max_heap_size, MaxHeapSize).
-
-
+
-
Sets whether to kill processes that reach the maximum heap size or not. If
+hmaxk is not given, the default is true. For more information,
@@ -676,7 +673,7 @@
Sets the initial process dictionary size of processes to the size
.
- +hmqd off_heap|on_heap
+ +hmqd off_heap|on_heap
Sets the default value for the process flag
message_queue_data. If +hmqd is not
diff --git a/erts/doc/src/erl_driver.xml b/erts/doc/src/erl_driver.xml
index 175b7f6bfb..82215ead46 100644
--- a/erts/doc/src/erl_driver.xml
+++ b/erts/doc/src/erl_driver.xml
@@ -348,14 +348,14 @@
all will work as before.
Time Measurement
- Support for time measurement in drivers:
+ Support for time measurement in drivers:
- ErlDrvTime
- ErlDrvTimeUnit
- erl_drv_monotonic_time()
- erl_drv_time_offset()
- erl_drv_convert_time_unit()
-
+
diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml
index 123d353432..8b02b3bae1 100644
--- a/erts/doc/src/erl_nif.xml
+++ b/erts/doc/src/erl_nif.xml
@@ -518,13 +518,15 @@ ok
int (*reload)(ErlNifEnv* env, void** priv_data, ERL_NIF_TERM load_info)
- The reload mechanism is deprecated. It was only intended
- as a development feature. Do not use it as an upgrade method for
- live production systems. It might be removed in future releases. Be sure
- to pass reload as NULL to ERL_NIF_INIT
- to disable it when not used.
-
- reload is called when the NIF library is loaded
+
+ -
+
The reload mechanism is deprecated. It was only intended
+ as a development feature. Do not use it as an upgrade method for
+ live production systems. It might be removed in future releases. Be sure
+ to pass reload as NULL to ERL_NIF_INIT
+ to disable it when not used.
+
+ reload is called when the NIF library is loaded
and there is already a previously loaded library for this
module code.
Works the same as load. The only difference is that
@@ -583,9 +585,9 @@ ok
typedef struct {
- const char* name;
- unsigned arity;
- ERL_NIF_TERM (*fptr)(ErlNifEnv* env, int argc, const ERL_NIF_TERM argv[]);
+ const char* name;
+ unsigned arity;
+ ERL_NIF_TERM (*fptr)(ErlNifEnv* env, int argc, const ERL_NIF_TERM argv[]);
unsigned flags;
} ErlNifFunc;
@@ -618,8 +620,8 @@ typedef struct {
typedef struct {
- unsigned size;
- unsigned char* data;
+ unsigned size;
+ unsigned char* data;
} ErlNifBinary;
ErlNifBinary contains transient information about an
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index fa13e4c142..6289f033b2 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -4361,86 +4361,86 @@ os_prompt%
-
Sets process flag max_heap_size for the calling process.
+
This flag sets the maximum heap size for the calling process.
If MaxHeapSize is an integer, the system default
values for kill and error_logger are used.
-
- size
- -
-
- The maximum size in words of the process. If set to zero, the
- heap size limit is disabled. Badarg will be thrown if the value is
- smaller than
- min_heap_size.
- The size check is only done when a garbage collection is triggered.
-
-
- size is the entire heap of the process when garbage collection
- is triggered, this includes all generational heaps, the process stack,
- any
- messages that are considered to be part of the heap and any
- extra memory that the garbage collector needs during collection.
-
-
- size is the same as can be retrieved using
-
- erlang:process_info(Pid, total_heap_size),
- or by adding heap_block_size, old_heap_block_size
- and mbuf_size from
- erlang:process_info(Pid, garbage_collection_info).
-
-
- kill
- -
-
- When set to true the runtime system will send an
- untrappable exit signal with reason kill to the process
- if the maximum heap size is reached. The garbage collection
- that triggered the kill will not be completed, instead the
- process will exit as soon as is possible. When set to false
- no exit signal will be sent to the process, instead it will
- continue executing.
-
-
- If kill is not defined in the map
- the system default will be used. The default system default
- is true. It can be changed by either the erl
- +hmaxk option,
- or
- erlang:system_flag(max_heap_size, MaxHeapSize).
-
-
- error_logger
- -
-
- When set to true the runtime system will send a
- message to the current error_logger
- containing details about the process when the maximum
- heap size is reached. One error_logger report will
- be sent each time the limit is reached.
-
-
- If error_logger is not defined in the map the system
- default will be used. The default system default is true.
- It can be changed by either the erl +hmaxel
- option, or
- erlang:system_flag(max_heap_size, MaxHeapSize).
-
-
+
+
+ size
+ -
+
+ The maximum size in words of the process. If set to zero, the
+ heap size limit is disabled. Badarg will be thrown if the value is
+ smaller than
+ min_heap_size.
+ The size check is only done when a garbage collection is triggered.
+
+
+ size is the entire heap of the process when garbage collection
+ is triggered, this includes all generational heaps, the process stack,
+ any
+ messages that are considered to be part of the heap and any
+ extra memory that the garbage collector needs during collection.
+
+
+ size is the same as can be retrieved using
+
+ erlang:process_info(Pid, total_heap_size),
+ or by adding heap_block_size, old_heap_block_size
+ and mbuf_size from
+ erlang:process_info(Pid, garbage_collection_info).
+
+
+ kill
+ -
+
+ When set to true the runtime system will send an
+ untrappable exit signal with reason kill to the process
+ if the maximum heap size is reached. The garbage collection
+ that triggered the kill will not be completed, instead the
+ process will exit as soon as is possible. When set to false
+ no exit signal will be sent to the process, instead it will
+ continue executing.
+
- The heap size of a process is quite hard to predict, especially the
- amount of memory that is used during the garbage collection. When
- contemplating using this option, it is recommended to first run
- it in production with kill set to false and inspect
- the error_logger reports to see what the normal peak sizes
- of the processes in the system is and then tune the value
- accordingly.
+ If kill is not defined in the map
+ the system default will be used. The default system default
+ is true. It can be changed by either the erl
+ +hmaxk option,
+ or
+ erlang:system_flag(max_heap_size, MaxHeapSize).
-
+
+ error_logger
+ -
+
+ When set to true the runtime system will send a
+ message to the current error_logger
+ containing details about the process when the maximum
+ heap size is reached. One error_logger report will
+ be sent each time the limit is reached.
+
+
+ If error_logger is not defined in the map the system
+ default will be used. The default system default is true.
+ It can be changed by either the erl +hmaxel
+ option, or
+ erlang:system_flag(max_heap_size, MaxHeapSize).
+
+
+
+
+ The heap size of a process is quite hard to predict, especially the
+ amount of memory that is used during the garbage collection. When
+ contemplating using this option, it is recommended to first run
+ it in production with kill set to false and inspect
+ the error_logger reports to see what the normal peak sizes
+ of the processes in the system is and then tune the value
+ accordingly.
@@ -4797,8 +4797,10 @@ os_prompt%
The content of GCInfo can be changed without
prior notice.
-
- {garbage_collection_info, GCInfo}
+
+
+ {garbage_collection_info, GCInfo}
+
-
GCInfo is a list containing miscellaneous
detailed information about garbage collection for this process.
@@ -4986,8 +4988,10 @@ os_prompt%
total suspend count on Suspendee,
only the parts contributed by Pid.
-
- {total_heap_size, Size}
+
+
+ {total_heap_size, Size}
+
-
Size is the total size, in words, of all heap
fragments of the process. This includes the process stack and
@@ -6631,8 +6635,8 @@ ok
-
Sets system flag max_heap_size
+
Sets the default maximum heap size settings for processes.
@@ -7136,9 +7140,9 @@ ok
+ Information about the default process heap settings.
- Information about the default process heap settings.
fullsweep_after
@@ -7183,7 +7187,7 @@ ok
where MinHeapSize is the current
system-wide minimum heap size for spawned processes.
- message_queue_data
+ message_queue_data
-
Returns the default value of the message_queue_data
process flag which is either off_heap, or on_heap.
@@ -7664,7 +7668,7 @@ ok
and
erlang:system_info(schedulers).
- otp_release
+ otp_release
-
Returns a string containing the OTP release number of the
@@ -8617,21 +8621,21 @@ timestamp() ->
send
-
Traces sending of messages.
- Message tags: send and
- send_to_non_existing_process.
+ Message tags: send and
+ send_to_non_existing_process.
'receive'
-
Traces receiving of messages.
- Message tags: 'receive'.
+ Message tags: 'receive'.
call
-
Traces certain function calls. Specify which function
calls to trace by calling
erlang:trace_pattern/3.
- Message tags: call and
- return_from.
+ Message tags: call and
+ return_from.
silent
-
@@ -8649,9 +8653,9 @@ timestamp() ->
specification function {silent,Bool}, giving
a high degree of control of which functions with which
arguments that trigger the trace.
- Message tags: call,
- return_from, and
- return_to. Or rather, the absence of.
+ Message tags: call,
+ return_from, and
+ return_to. Or rather, the absence of.
return_to
-
@@ -8672,43 +8676,43 @@ timestamp() ->
To get trace messages containing return values from
functions, use the {return_trace} match
specification action instead.
- Message tags: return_to.
+ Message tags: return_to.
procs
-
Traces process-related events.
- Message tags: spawn,
- spawned,
- exit,
- register,
- unregister,
- link,
- unlink,
- getting_linked, and
- getting_unlinked.
+ Message tags: spawn,
+ spawned,
+ exit,
+ register,
+ unregister,
+ link,
+ unlink,
+ getting_linked, and
+ getting_unlinked.
ports
-
Traces port-related events.
- Message tags: open,
- closed,
- register,
- unregister,
- getting_linked, and
- getting_unlinked.
+ Message tags: open,
+ closed,
+ register,
+ unregister,
+ getting_linked, and
+ getting_unlinked.
running
-
Traces scheduling of processes.
- Message tags: in and
- out.
+ Message tags: in and
+ out.
exiting
-
Traces scheduling of exiting processes.
- Message tags: in_exiting,
- out_exiting, and
- out_exited.
+ Message tags: in_exiting,
+ out_exiting, and
+ out_exited.
running_procs
-
@@ -8716,21 +8720,21 @@ timestamp() ->
However this option also includes schedule events when the
process executes within the context of a port without
being scheduled out itself.
-
Message tags: in and
- out.
+ Message tags: in and
+ out.
running_ports
-
Traces scheduling of ports.
- Message tags: in and
- out.
+ Message tags: in and
+ out.
garbage_collection
-
Traces garbage collections of processes.
- Message tags: gc_minor_start,
- gc_max_heap_size and
- gc_minor_end.
+ Message tags: gc_minor_start,
+ gc_max_heap_size and
+ gc_minor_end.
timestamp
-
@@ -8758,7 +8762,7 @@ timestamp() ->
Erlang
monotonic time time-stamp in all trace messages. The
time-stamp (Ts) has the same format and value as produced by
- erlang:monotonic_time(nano_seconds).
+ erlang:monotonic_time(nano_seconds).
This flag overrides the cpu_timestamp flag.
strict_monotonic_timestamp
@@ -8768,8 +8772,8 @@ timestamp() ->
monotonic time and a monotonically increasing
integer in all trace messages. The time-stamp (Ts) has the
same format and value as produced by
- {erlang:monotonic_time(nano_seconds),
- erlang:unique_integer([monotonic])}.
+ {erlang:monotonic_time(nano_seconds),
+ erlang:unique_integer([monotonic])}.
This flag overrides the cpu_timestamp flag.
arity
--
cgit v1.2.3