From 036c56d3ee969daa39c1e03de69744ba394f0fe3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Thu, 20 Oct 2016 14:08:31 +0200 Subject: erl_interface: Fix editorial changes --- lib/erl_interface/doc/src/ei.xml | 20 ++++++++++---------- lib/erl_interface/doc/src/ei_connect.xml | 4 ++-- lib/erl_interface/doc/src/ei_users_guide.xml | 10 +++++----- lib/erl_interface/doc/src/erl_call.xml | 4 ++-- lib/erl_interface/doc/src/erl_connect.xml | 8 ++++---- lib/erl_interface/doc/src/erl_eterm.xml | 18 +++++++++--------- lib/erl_interface/doc/src/erl_format.xml | 4 ++-- lib/erl_interface/doc/src/erl_interface.xml | 6 +++--- lib/erl_interface/doc/src/erl_malloc.xml | 4 ++-- lib/erl_interface/doc/src/erl_marshal.xml | 2 +- lib/erl_interface/doc/src/part_erl_interface.xml | 5 ++--- lib/erl_interface/doc/src/ref_man_erl_interface.xml | 5 ++--- 12 files changed, 44 insertions(+), 46 deletions(-) (limited to 'lib/erl_interface/doc') diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index 6d416028a5..9b01f4af98 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -97,7 +97,7 @@ buffer must be allocated large enough, and for non-compound types the function returns the size required (notice that for strings an - extra byte is needed for the 0 string terminator).

+ extra byte is needed for the NULL-terminator).

@@ -110,14 +110,14 @@ typedef enum { ERLANG_ASCII = 1, ERLANG_LATIN1 = 2, ERLANG_UTF8 = 4 -}erlang_char_encoding; +} erlang_char_encoding;

The character encodings used for atoms. ERLANG_ASCII represents 7-bit ASCII. Latin-1 and UTF-8 are different extensions of 7-bit ASCII. All 7-bit ASCII characters are valid Latin-1 and UTF-8 characters. ASCII and Latin-1 both represent each character - by one byte. An UTF-8 character can consist of 1-4 bytes. - Notice that these - constants are bit-flags and can be combined with bitwise OR.

+ by one byte. An UTF-8 character can consist of 1-4 bytes. + Notice that these constants are bit-flags and can be combined with + bitwise OR.

@@ -409,7 +409,7 @@ typedef enum {

Encodes an atom in the binary format. Parameter is the name of the atom in Latin-1 encoding. Only up to MAXATOMLEN-1 bytes - are encoded. The name is to be zero-terminated, except for + are encoded. The name is to be NULL-terminated, except for the function.

@@ -426,7 +426,7 @@ typedef enum { (Latin-1 or UTF-8). Parameter p is the name of the atom with character encoding from_enc - (ASCII, Latin-1, or UTF-8). The name must either be zero-terminated or + (ASCII, Latin-1, or UTF-8). The name must either be NULL-terminated or a function variant with a len parameter must be used. If to_enc is set to the bitwise OR'd combination (ERLANG_LATIN1|ERLANG_UTF8), UTF-8 encoding is only used if the @@ -645,7 +645,7 @@ ei_x_encode_string(&x, "Banana");

Encodes a string in the binary format. (A string in Erlang is a list, but is encoded as a character array in the binary - format.) The string is to be zero-terminated, except for + format.) The string is to be NULL-terminated, except for the function.

 @@ -731,7 +731,7 @@ ei_encode_tuple_header(buf, &i, 0);

Returns the type in and size in of the encoded term. For strings and atoms, size is the number of characters not including the - terminating 0. For binaries, is the number of + terminating NULL. For binaries, is the number of bytes. For lists and tuples, is the arity of the object. For other types, is 0. In all cases, is left unchanged.

@@ -753,7 +753,7 @@ ei_encode_tuple_header(buf, &i, 0); bytes or a NULL pointer. The string can be reallocated (and can be updated) by this function if the result is more than - characters. The string returned is zero-terminated.

+ characters. The string returned is NULL-terminated.

The return value is the number of characters written to the file or string, or -1 if does not contain a valid term. diff --git a/lib/erl_interface/doc/src/ei_connect.xml b/lib/erl_interface/doc/src/ei_connect.xml index a5a020ffda..08ae3db071 100644 --- a/lib/erl_interface/doc/src/ei_connect.xml +++ b/lib/erl_interface/doc/src/ei_connect.xml @@ -303,7 +303,7 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) { Publish a node name.

Used by a server process to register - with the local name server epmd, thereby allowing + with the local name server EPMD, thereby allowing other processes to send messages by using the registered name. Before calling either of these functions, the process should have called and @@ -570,7 +570,7 @@ if (ei_reg_send(&ec, fd, x.buff, x.index) < 0) call. combines the functionality of these two functions by sending an RPC request and waiting for the results. See also - rpc:call/4 in Kernel.

+ rpc:call/4 in Kernel.

is the C-node structure previously diff --git a/lib/erl_interface/doc/src/ei_users_guide.xml b/lib/erl_interface/doc/src/ei_users_guide.xml index 9499a07467..e6f4acb55f 100644 --- a/lib/erl_interface/doc/src/ei_users_guide.xml +++ b/lib/erl_interface/doc/src/ei_users_guide.xml @@ -106,7 +106,7 @@ Eshell V4.7.4 (abort with ^G) argument on the command line, or add it to the definition in your . The correct value for this path is - Vsn, + , where:

@@ -115,7 +115,7 @@ Eshell V4.7.4 (abort with ^G) in the example above.

 -

Vsn is the version of the Erl_Interface application, +

is the version of the Erl_Interface application, for example, .

 @@ -552,8 +552,8 @@ erl_free_term(reply); ]]>
Using Global Names

A C node has access to names registered through the - kernel:global - module. Names can be looked up, allowing the C node to send messages + global + module in Kernel. Names can be looked up, allowing the C node to send messages to named Erlang services. C nodes can also register global names, allowing them to provide named services to Erlang processes or other C nodes.

@@ -648,7 +648,7 @@ erl_global_unregister(fd,servicename); ]]> detailed information about the individual API functions, see the registry module.

-

Keys are strings, that is, zero-terminated arrays of characters, and +

Keys are strings, that is, NULL-terminated arrays of characters, and values are arbitrary objects. Although integers and floating point numbers are treated specially by the registry, you can store strings or binary objects of any type as pointers.

diff --git a/lib/erl_interface/doc/src/erl_call.xml b/lib/erl_interface/doc/src/erl_call.xml index ebd9172f98..706dd271cc 100644 --- a/lib/erl_interface/doc/src/erl_call.xml +++ b/lib/erl_interface/doc/src/erl_call.xml @@ -215,8 +215,8 @@ Y=2,

(In the example, the output has been formatted afterwards.)

P = processes(), diff --git a/lib/erl_interface/doc/src/erl_connect.xml b/lib/erl_interface/doc/src/erl_connect.xml index a027cb0a84..3796a763c3 100644 --- a/lib/erl_interface/doc/src/erl_connect.xml +++ b/lib/erl_interface/doc/src/erl_connect.xml @@ -165,7 +165,7 @@ erl_xconnect( &addr , ALIVE );

Initializes the module. In particular, these functions are used to identify the name of the C-node from which they are called. One of these functions must - be called before any of the other functions in the erl_connect + be called before any of the other functions in the erl_connect module are used.

stores for later use information about:

@@ -196,7 +196,7 @@ erl_xconnect( &addr , ALIVE );

is the node name. It is to - be of the form alivename@hostname.

+ be of the form alivename@hostname.

is the 32-bit IP address of @@ -212,7 +212,7 @@ erl_xconnect( &addr , ALIVE ); and variables on Windows. For more details, see the - kernel:auth module.

+ auth module in Kernel.

helps identifying a particular @@ -255,7 +255,7 @@ if (!erl_connect_init(17, "samplecookiestring...", 0))

This function is used by a server process to register - with the local name server epmd, thereby allowing + with the local name server EPMD, thereby allowing other processes to send messages by using the registered name. Before calling this function, the process should have called and diff --git a/lib/erl_interface/doc/src/erl_eterm.xml b/lib/erl_interface/doc/src/erl_eterm.xml index 8a46c20432..ee10c3cf0b 100644 --- a/lib/erl_interface/doc/src/erl_eterm.xml +++ b/lib/erl_interface/doc/src/erl_eterm.xml @@ -201,13 +201,13 @@ erl_free_compound(list);

Extracts a specified element from an Erlang tuple.

- + specifies which element to retrieve from . The elements are numbered starting from 1. is an Erlang term containing at least elements. - +

Returns a new Erlang term corresponding to the requested element, or NULL if was greater than the arity of .

@@ -292,12 +292,12 @@ iohead ::= Binary char *erl_iolist_to_string(list) - Convert an I/O list to a zero-terminated string. + Convert an I/O list to a NULL-terminated string. ETERM *list; -

Converts an I/O list to a '\0' terminated C string.

+

Converts an I/O list to a NULL-terminated C string.

is an Erlang term containing an I/O list. The I/O list must not contain the integer 0, as C strings may not contain this value except as a terminating marker.

@@ -344,14 +344,14 @@ iohead ::= Binary contains a valid name for an atom.

and - can be used to retrieve the atom name (as a null-terminated string). + can be used to retrieve the atom name (as a NULL-terminated string). and return the length of the atom name.

The UTF-8 variants were introduced in Erlang/OTP R16 and the string returned by ERL_ATOM_PTR(atom) was not - null-terminated on older releases.

+ NULL-terminated on older releases.

 @@ -400,7 +400,7 @@ iohead ::= Binary

Creates a list from a sequence of bytes.

is a buffer containing a sequence of - bytes. The buffer does not need to be zero-terminated. + bytes. The buffer does not need to be NULL-terminated. is the length of . @@ -586,8 +586,8 @@ iohead ::= Binary char *string; -

Creates a list from a zero-terminated string.

-

is the zero-terminated sequence of +

Creates a list from a NULL-terminated string.

+

is a NULL-terminated sequence of characters (that is, a C string) from which the list will be created.

Returns an Erlang list.

diff --git a/lib/erl_interface/doc/src/erl_format.xml b/lib/erl_interface/doc/src/erl_format.xml index 9fe405d51c..170e984b34 100644 --- a/lib/erl_interface/doc/src/erl_format.xml +++ b/lib/erl_interface/doc/src/erl_format.xml @@ -89,8 +89,8 @@ erl_format("[{name,~a},{age,~i},{data,~w}]",

This function is used to perform pattern matching similar - to that done in Erlang. For matching rules and more exemples, see - section + to that done in Erlang. For matching rules and more examples, see + section Pattern Matching in the Erlang Reference Manual.

is an Erlang term, possibly diff --git a/lib/erl_interface/doc/src/erl_interface.xml b/lib/erl_interface/doc/src/erl_interface.xml index a9d421bbeb..2a3831cf0f 100644 --- a/lib/erl_interface/doc/src/erl_interface.xml +++ b/lib/erl_interface/doc/src/erl_interface.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + The Erl_Interface Library @@ -500,7 +500,7 @@ erl_global_unregister(fd,servicename); ]]> restoring them from a Mnesia table on an Erlang node. More detailed information about the individual API functions can be found in the Reference Manual.

-

Keys are strings, i.e. 0-terminated arrays of characters, and values +

Keys are strings, i.e. NULL-terminated arrays of characters, and values are arbitrary objects. Although integers and floating point numbers are treated specially by the registry, you can store strings or binary objects of any type as pointers.

diff --git a/lib/erl_interface/doc/src/erl_malloc.xml b/lib/erl_interface/doc/src/erl_malloc.xml index 28de9dfa88..3891073158 100644 --- a/lib/erl_interface/doc/src/erl_malloc.xml +++ b/lib/erl_interface/doc/src/erl_malloc.xml @@ -173,8 +173,8 @@ subterms associated with a specified Erlang term, regardless of whether we are still holding pointers to the subterms.

For an example, see section - Building Terms and - Patterns"> in the User's Guide.

+ Building Terms and Patterns + in the User's Guide.

diff --git a/lib/erl_interface/doc/src/erl_marshal.xml b/lib/erl_interface/doc/src/erl_marshal.xml index 30b7281a51..b333bc9993 100644 --- a/lib/erl_interface/doc/src/erl_marshal.xml +++ b/lib/erl_interface/doc/src/erl_marshal.xml @@ -57,7 +57,7 @@

Returns 0 if the terms are equal, -1 if term1 < term2, or 1 if term2 < - term1.

+ term1.

diff --git a/lib/erl_interface/doc/src/part_erl_interface.xml b/lib/erl_interface/doc/src/part_erl_interface.xml index 2abe7ecd60..e256cfa193 100644 --- a/lib/erl_interface/doc/src/part_erl_interface.xml +++ b/lib/erl_interface/doc/src/part_erl_interface.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + Erl_Interface User's Guide @@ -31,4 +31,3 @@ - diff --git a/lib/erl_interface/doc/src/ref_man_erl_interface.xml b/lib/erl_interface/doc/src/ref_man_erl_interface.xml index fb39c5a7e4..4b1d0e9981 100644 --- a/lib/erl_interface/doc/src/ref_man_erl_interface.xml +++ b/lib/erl_interface/doc/src/ref_man_erl_interface.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -19,7 +19,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - + Erl_Interface Library Reference @@ -50,4 +50,3 @@ - -- cgit v1.2.3