From df88b47cdafcc2e04452456942ea572a7b72e2f2 Mon Sep 17 00:00:00 2001 From: Lars G Thorsen Date: Tue, 26 Jan 2010 10:13:35 +0000 Subject: OTP-8343 The documentation is now possible to build in an open source environment after a number of bugs are fixed and some features are added in the documentation build process. - The arity calculation is updated. - The module prefix used in the function names for bif's are removed in the generated links so the links will look like http://www.erlang.org/doc/man/erlang.html#append_element-2 instead of http://www.erlang.org/doc/man/erlang.html#erlang:append_element-2 - Enhanced the menu positioning in the html documentation when a new page is loaded. - A number of corrections in the generation of man pages (thanks to Sergei Golovan) - Moved some man pages to more apropriate sections, pages in section 4 moved to 5 and pages in 6 moved to 7. - The legal notice is taken from the xml book file so OTP's build process can be used for non OTP applications. --- erts/doc/src/erl.xml | 2 +- erts/doc/src/erl_driver.xml | 8 ++-- erts/doc/src/erl_nif.xml | 4 +- erts/doc/src/erlang.xml | 112 ++++++++++++++++++++++---------------------- erts/doc/src/notes.xml | 8 ++-- 5 files changed, 67 insertions(+), 67 deletions(-) (limited to 'erts/doc') diff --git a/erts/doc/src/erl.xml b/erts/doc/src/erl.xml index 6f5dd248ce..b01d187b01 100644 --- a/erts/doc/src/erl.xml +++ b/erts/doc/src/erl.xml @@ -410,7 +410,7 @@

Sets the magic cookie of the node to , see - erlang:set_cookie/2.

+ erlang:set_cookie/2.

 diff --git a/erts/doc/src/erl_driver.xml b/erts/doc/src/erl_driver.xml index 0b11f4bbcb..5d7a11b70a 100644 --- a/erts/doc/src/erl_driver.xml +++ b/erts/doc/src/erl_driver.xml @@ -4,7 +4,7 @@
- 20012009 + 20012010 Ericsson AB. All Rights Reserved. @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + erl_driver @@ -1292,7 +1292,7 @@ typedef struct ErlIOVec { has been set in the driver_entry, data can be forced into the driver via - port_command(Port, Data, [force]) + port_command(Port, Data, [force]) even though the driver has signaled that it is busy.

diff --git a/erts/doc/src/erl_nif.xml b/erts/doc/src/erl_nif.xml index 2033ba8a66..2902d70976 100644 --- a/erts/doc/src/erl_nif.xml +++ b/erts/doc/src/erl_nif.xml @@ -148,7 +148,7 @@ ok that the library needs in able to keep a state between NIF calls. enif_get_data() will return this pointer.

load_info is the second argument to erlang:load_nif/2.

+ marker="erlang#load_nif-2">erlang:load_nif/2.

The library will fail to load if load returns anything other than 0. load can be NULL in case no initialization is needed.

@@ -397,7 +397,7 @@ typedef struct {
SEE ALSO -

load_nif(3)

+

load_nif(3)

diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml index 28b040a441..207aabca35 100644 --- a/erts/doc/src/erlang.xml +++ b/erts/doc/src/erlang.xml @@ -452,19 +452,19 @@ iolist() = [char() | binary() | iolist()]

Cancels a timer, where TimerRef was returned by either - erlang:send_after/3 + erlang:send_after/3 or - erlang:start_timer/3. + erlang:start_timer/3. If the timer is there to be removed, the function returns the time in milliseconds left until the timer would have expired, otherwise false (which means that TimerRef was never a timer, that it has already been cancelled, or that it has already delivered its message).

See also - erlang:send_after/3, - erlang:start_timer/3, + erlang:send_after/3, + erlang:start_timer/3, and - erlang:read_timer/1.

+ erlang:read_timer/1.

Note: Cancelling a timer does not guarantee that the message has not already been delivered to the message queue.

 @@ -715,7 +715,7 @@ false

If MonitorRef is a reference which the calling process obtained by calling - erlang:monitor/2, + erlang:monitor/2, this monitoring is turned off. If the monitoring is already turned off, nothing happens.

Once erlang:demonitor(MonitorRef) has returned it is @@ -726,7 +726,7 @@ false the call, though. Therefore, in most cases, it is advisable to remove such a 'DOWN' message from the message queue after monitoring has been stopped. - erlang:demonitor(MonitorRef, [flush]) can be used instead of + erlang:demonitor(MonitorRef, [flush]) can be used instead of erlang:demonitor(MonitorRef) if this cleanup is wanted.

Prior to OTP release R11B (erts version 5.5) erlang:demonitor/1 @@ -760,7 +760,7 @@ false of OptionList.

erlang:demonitor(MonitorRef, []) is equivalent to - erlang:demonitor(MonitorRef).

+ erlang:demonitor(MonitorRef).

Currently the following Options are valid:

flush @@ -810,7 +810,7 @@ false

Failure: badarg if OptionList is not a list, or if Option is not a valid option, or the same failure as for - erlang:demonitor/1

+ erlang:demonitor/1

 @@ -1129,7 +1129,7 @@ b uniq, and pid. For an external fun, the value of any of these items is always the atom undefined.

See - erlang:fun_info/1.

+ erlang:fun_info/1.

 @@ -1275,8 +1275,8 @@ b returns, for example:

{'EXIT',{badarg,Stacktrace}} = catch abs(x)

See also - erlang:error/1 and - erlang:error/2.

+ erlang:error/1 and + erlang:error/2.

 @@ -2387,7 +2387,7 @@ os_prompt% If Type is not one of the memory types listed in the documentation of - erlang:memory/0. + erlang:memory/0. badarg @@ -2401,7 +2401,7 @@ os_prompt%

See also - erlang:memory/0.

+ erlang:memory/0.

 @@ -2510,7 +2510,7 @@ os_prompt%

The monitoring is turned off either when the 'DOWN' message is sent, or when - erlang:demonitor/1 + erlang:demonitor/1 is called.

If an attempt is made to monitor a process on an older node (where remote process monitoring is not implemented or one @@ -3379,7 +3379,7 @@ os_prompt% registered name, [] is returned.

For valid values of Item, and corresponding values of Info, see - erlang:port_info/1.

+ erlang:port_info/1.

Failure: badarg if Port is not a local port.

 @@ -3868,9 +3868,9 @@ os_prompt% ActiveSuspendCount, OutstandingSuspendCount} tuples. Suspendee is the pid of a process that have been or is to be suspended by the process identified by Pid via the - erlang:suspend_process/2 + erlang:suspend_process/2 BIF, or the - erlang:suspend_process/1 + erlang:suspend_process/1 BIF. ActiveSuspendCount is the number of times the Suspendee has been suspended by Pid. OutstandingSuspendCount is the number of not yet @@ -4021,19 +4021,19 @@ os_prompt%

TimerRef is a timer reference returned by - erlang:send_after/3 + erlang:send_after/3 or - erlang:start_timer/3. + erlang:start_timer/3. If the timer is active, the function returns the time in milliseconds left until the timer will expire, otherwise false (which means that TimerRef was never a timer, that it has been cancelled, or that it has already delivered its message).

See also - erlang:send_after/3, - erlang:start_timer/3, + erlang:send_after/3, + erlang:start_timer/3, and - erlang:cancel_timer/1.

+ erlang:cancel_timer/1.

 @@ -4098,9 +4098,9 @@ true

Decreases the suspend count on the process identified by Suspendee. Suspendee should previously have been suspended via - erlang:suspend_process/2, + erlang:suspend_process/2, or - erlang:suspend_process/1 + erlang:suspend_process/1 by the process calling erlang:resume_process(Suspendee). When the suspend count on Suspendee reach zero, Suspendee will be resumed, i.e., the state of the Suspendee is changed @@ -4186,9 +4186,9 @@ true

Sends a message and returns ok, or does not send the message but returns something else (see below). Otherwise the same as - erlang:send/2. See + erlang:send/2. See also - erlang:send_nosuspend/2,3. + erlang:send_nosuspend/2,3. for more detailed explanation and warnings.

The possible options are:

@@ -4234,10 +4234,10 @@ true erts version 5.4.11. Note that timers will not be automatically canceled when Dest is an atom.

See also - erlang:start_timer/3, - erlang:cancel_timer/1, + erlang:start_timer/3, + erlang:cancel_timer/1, and - erlang:read_timer/1.

+ erlang:read_timer/1.

Failure: badarg if the arguments does not satisfy the requirements specified above.

@@ -4253,7 +4253,7 @@ true

The same as - erlang:send(Dest, Msg, [nosuspend]), but returns true if + erlang:send(Dest, Msg, [nosuspend]), but returns true if the message was sent and false if the message was not sent because the sender would have had to be suspended.

This function is intended for send operations towards an @@ -4305,10 +4305,10 @@ true

The same as - erlang:send(Dest, Msg, [nosuspend | Options]), + erlang:send(Dest, Msg, [nosuspend | Options]), but with boolean return value.

This function behaves like - erlang:send_nosuspend/2), + erlang:send_nosuspend/2), but takes a third parameter, a list of options. The only currently implemented option is noconnect. The option noconnect makes the function return false if @@ -4610,7 +4610,7 @@ true monitor

Monitor the new process (just like - erlang:monitor/2 does).

+ erlang:monitor/2 does).

{priority, Level} @@ -4653,7 +4653,7 @@ true and no virtual memory, one might want to preserve memory by setting Number to zero. (The value may be set globally, see - erlang:system_flag/2.)

+ erlang:system_flag/2.)

 {min_heap_size, Size} @@ -4764,10 +4764,10 @@ true erts version 5.4.11. Note that timers will not be automatically canceled when Dest is an atom.

See also - erlang:send_after/3, - erlang:cancel_timer/1, + erlang:send_after/3, + erlang:cancel_timer/1, and - erlang:read_timer/1.

+ erlang:read_timer/1.

Failure: badarg if the arguments does not satisfy the requirements specified above.

 @@ -4872,7 +4872,7 @@ true process will not leave the suspended state until its suspend count reach zero. The suspend count of Suspendee is decreased when - erlang:resume_process(Suspendee) + erlang:resume_process(Suspendee) is called by the same process that called erlang:suspend_process(Suspendee). All increased suspend counts on other processes acquired by a process will automatically be @@ -4961,7 +4961,7 @@ true

Suspends the process identified by Suspendee. The same as calling - erlang:suspend_process(Suspendee, []). For more information see the documentation of erlang:suspend_process/2. + erlang:suspend_process(Suspendee, []). For more information see the documentation of erlang:suspend_process/2.

This BIF is intended for debugging only.

@@ -5272,7 +5272,7 @@ true Some values are part of other values, and some memory areas are not part of the result. If you are interested in the total amount of memory allocated by the emulator - see erlang:memory/0,1.

+ see erlang:memory/0,1.

allocator @@ -5587,7 +5587,7 @@ true spawn or spawn_link will use these garbage collection settings. The default settings can be changed by use of - system_flag/2. + system_flag/2. spawn_opt/4 can spawn a process that does not use the default settings.

@@ -5900,7 +5900,7 @@ true

Returns the current system monitoring settings set by - erlang:system_monitor/2 + erlang:system_monitor/2 as {MonitorPid, Options}, or undefined if there are no settings. The order of the options may be different from the one that was set.

@@ -5918,9 +5918,9 @@ true system performance monitoring settings are cleared.

Calling the function with {MonitorPid, Options} as argument, is the same as calling - erlang:system_monitor(MonitorPid, Options).

+ erlang:system_monitor(MonitorPid, Options).

Returns the previous system monitor settings just like - erlang:system_monitor/0.

+ erlang:system_monitor/0.

 @@ -5956,7 +5956,7 @@ true explained in the documentation of the gc_start trace message (see - erlang:trace/3). + erlang:trace/3). New tuples may be added, and the order of the tuples in the Info list may be changed at any time without prior notice. @@ -5998,7 +5998,7 @@ true

Returns the previous system monitor settings just like - erlang:system_monitor/0.

+ erlang:system_monitor/0.

If a monitoring process gets so large that it itself starts to cause system monitor messages when garbage @@ -6022,7 +6022,7 @@ true

Returns the current system profiling settings set by - erlang:system_profile/2 + erlang:system_profile/2 as {ProfilerPid, Options}, or undefined if there are no settings. The order of the options may be different from the one that was set.

@@ -6250,7 +6250,7 @@ true

Trace certain function calls. Specify which function calls to trace by calling - erlang:trace_pattern/3.

+ erlang:trace_pattern/3.

Message tags: call, return_from.

 silent @@ -6279,7 +6279,7 @@ true Trace the actual return from a traced function back to its caller. Only works for functions traced with the local option to - erlang:trace_pattern/3.

+ erlang:trace_pattern/3.

The semantics is that a trace message is sent when a call traced function actually returns, that is, when a chain of tail recursive calls is ended. There will be @@ -6667,7 +6667,7 @@ true true for the pseudo function on_load if call count tracing is active. Return false otherwise. See also - erlang:trace_pattern/3.

+ erlang:trace_pattern/3.

all @@ -6690,7 +6690,7 @@ true Set trace patterns for global call tracing

The same as - erlang:trace_pattern(MFA, MatchSpec, []), + erlang:trace_pattern(MFA, MatchSpec, []), retained for backward compatibility.

 @@ -6703,7 +6703,7 @@ true

This BIF is used to enable or disable call tracing for exported functions. It must be combined with - erlang:trace/3 + erlang:trace/3 to set the call trace flag for one or more processes.

Conceptually, call tracing works like this: Inside the Erlang virtual machine there is a set of processes to be @@ -6713,7 +6713,7 @@ true in the traced function set, the trace action will be taken. Otherwise, nothing will happen.

Use - erlang:trace/3 to + erlang:trace/3 to add or remove one or more processes to the set of traced processes. Use erlang:trace_pattern/2 to add or remove exported functions to the set of traced functions.

@@ -6830,7 +6830,7 @@ true counters can be restarted from zero with MatchSpec == restart.

The counter value can be read with - erlang:trace_info/2.

+ erlang:trace_info/2.

The global and local options are mutually @@ -6850,7 +6850,7 @@ true specification list. If a function has a match specification, you can replace it with a completely new one. If you need to change an existing match specification, use the - erlang:trace_info/2 + erlang:trace_info/2 BIF to retrieve the existing match specification.

Returns the number of exported functions that matched the MFA argument. This will be zero if none matched at diff --git a/erts/doc/src/notes.xml b/erts/doc/src/notes.xml index 2252358e0d..5fe414841e 100644 --- a/erts/doc/src/notes.xml +++ b/erts/doc/src/notes.xml @@ -4,7 +4,7 @@

- 20042009 + 20042010 Ericsson AB. All Rights Reserved. @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + ERTS Release Notes @@ -242,7 +242,7 @@

The erlang:port_command/3 + marker="erlang#port_command/3">erlang:port_command/3 BIF has been added. erlang:port_command/3 is currently not auto imported, but it is planned to be auto imported in OTP R14. For more information see the -- cgit v1.2.3