Skip to content

Commit

Permalink
erl_interface: Fix editorial changes
Browse files Browse the repository at this point in the history
  • Loading branch information
psyeugenic committed Oct 24, 2016
1 parent 031f9ca commit 036c56d
Show file tree
Hide file tree
Showing 12 changed files with 44 additions and 46 deletions.
20 changes: 10 additions & 10 deletions lib/erl_interface/doc/src/ei.xml
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@
buffer must be allocated large enough, and for non-compound types
the <c><![CDATA[ei_get_type()]]></c>
function returns the size required (notice that for strings an
extra byte is needed for the 0 string terminator).</p>
extra byte is needed for the <c>NULL</c>-terminator).</p>
</description>

<section>
Expand All @@ -110,14 +110,14 @@ typedef enum {
ERLANG_ASCII = 1,
ERLANG_LATIN1 = 2,
ERLANG_UTF8 = 4
}erlang_char_encoding;</code>
} erlang_char_encoding;</code>
<p>The character encodings used for atoms. <c>ERLANG_ASCII</c>
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.</p>
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.</p>
</item>
</taglist>
</section>
Expand Down Expand Up @@ -409,7 +409,7 @@ typedef enum {
<p>Encodes an atom in the binary format. Parameter <c><![CDATA[p]]></c>
is the name of the atom in Latin-1 encoding. Only up to
<c>MAXATOMLEN-1</c> bytes
are encoded. The name is to be zero-terminated, except for
are encoded. The name is to be <c>NULL</c>-terminated, except for
the <c><![CDATA[ei_x_encode_atom_len()]]></c> function.</p>
</desc>
</func>
Expand All @@ -426,7 +426,7 @@ typedef enum {
(Latin-1 or UTF-8). Parameter <c>p</c> is the name of the atom with
character encoding
<seealso marker="#erlang_char_encoding"><c>from_enc</c></seealso>
(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 <c>NULL</c>-terminated or
a function variant with a <c>len</c> parameter must be used.
If <c>to_enc</c> is set to the bitwise OR'd combination
<c>(ERLANG_LATIN1|ERLANG_UTF8)</c>, UTF-8 encoding is only used if the
Expand Down Expand Up @@ -645,7 +645,7 @@ ei_x_encode_string(&amp;x, "Banana");</pre>
<desc>
<p>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 <c>NULL</c>-terminated, except for
the <c><![CDATA[ei_x_encode_string_len()]]></c> function.</p>
</desc>
</func>
Expand Down Expand Up @@ -731,7 +731,7 @@ ei_encode_tuple_header(buf, &amp;i, 0);</pre>
<p>Returns the type in <c><![CDATA[type]]></c> and size in
<c><![CDATA[size]]></c> of the encoded term. For strings and atoms,
size is the number of characters <em>not</em> including the
terminating 0. For binaries, <c><![CDATA[size]]></c> is the number of
terminating <c>NULL</c>. For binaries, <c><![CDATA[size]]></c> is the number of
bytes. For lists and tuples, <c><![CDATA[size]]></c> is the arity of
the object. For other types, <c><![CDATA[size]]></c> is 0. In all
cases, <c><![CDATA[index]]></c> is left unchanged.</p>
Expand All @@ -753,7 +753,7 @@ ei_encode_tuple_header(buf, &amp;i, 0);</pre>
<c><![CDATA[BUFSIZ]]></c> bytes or a <c>NULL</c> pointer. The string
can be reallocated (and <c><![CDATA[*s]]></c> can be updated) by this
function if the result is more than <c><![CDATA[BUFSIZ]]></c>
characters. The string returned is zero-terminated.</p>
characters. The string returned is <c>NULL</c>-terminated.</p>
<p>The return value is the number of characters written to the file
or string, or <c>-1</c> if <c><![CDATA[buf[index]]]></c> does not
contain a valid term.
Expand Down
4 changes: 2 additions & 2 deletions lib/erl_interface/doc/src/ei_connect.xml
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ if (ei_connect_init(&ec, "madonna", "cookie...", n++) < 0) {
<fsummary>Publish a node name.</fsummary>
<desc>
<p>Used by a server process to register
with the local name server <em>epmd</em>, 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 <c><![CDATA[bind()]]></c> and <c><![CDATA[listen()]]></c>
Expand Down Expand Up @@ -570,7 +570,7 @@ if (ei_reg_send(&ec, fd, x.buff, x.index) < 0)
call. <c><![CDATA[ei_rpc()]]></c> combines the functionality of these
two functions by sending an RPC request and waiting for the results.
See also <seealso marker="kernel:rpc#call/4">
<c>rpc:call/4</c></seealso> in <c>Kernel</c>.</p>
<c>rpc:call/4</c></seealso> in Kernel.</p>
<list type="bulleted">
<item>
<p><c><![CDATA[ec]]></c> is the C-node structure previously
Expand Down
10 changes: 5 additions & 5 deletions lib/erl_interface/doc/src/ei_users_guide.xml
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Eshell V4.7.4 (abort with ^G)
<c><![CDATA[-I]]></c> argument on the command line, or add it to
the <c><![CDATA[CFLAGS]]></c> definition in your
<c><![CDATA[Makefile]]></c>. The correct value for this path is
<c><![CDATA[$OTPROOT/lib/erl_interface]]></c><em>Vsn</em><c><![CDATA[/include]]></c>,
<c><![CDATA[$OTPROOT/lib/erl_interface-$EIVSN/include]]></c>,
where:</p>

<list type="bulleted">
Expand All @@ -115,7 +115,7 @@ Eshell V4.7.4 (abort with ^G)
<c><![CDATA[code:root_dir/0]]></c> in the example above.</p>
</item>
<item>
<p><em>Vsn</em> is the version of the <c>Erl_Interface</c> application,
<p><c><![CDATA[$EIVSN]]></c> is the version of the <c>Erl_Interface</c> application,
for example, <c><![CDATA[erl_interface-3.2.3]]></c>.</p>
</item>
</list>
Expand Down Expand Up @@ -552,8 +552,8 @@ erl_free_term(reply); ]]></code>
<section>
<title>Using Global Names</title>
<p>A C node has access to names registered through the
<seealso marker="kernel:global"><c>kernel:global</c></seealso>
module. Names can be looked up, allowing the C node to send messages
<seealso marker="kernel:global"><c>global</c></seealso>
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.</p>
Expand Down Expand Up @@ -648,7 +648,7 @@ erl_global_unregister(fd,servicename); ]]></code>
detailed information about the individual API functions, see the
<seealso marker="registry"><c>registry</c></seealso> module.</p>

<p>Keys are strings, that is, zero-terminated arrays of characters, and
<p>Keys are strings, that is, <c>NULL</c>-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.</p>
Expand Down
4 changes: 2 additions & 2 deletions lib/erl_interface/doc/src/erl_call.xml
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,8 @@ Y=2,
<p>(In the example, the output has been formatted afterwards.)</p>

<code type="none"><![CDATA[
erl_call -s -m -a lolita -n madonna
-module(lolita).
erl_call -s -m -a procnames -n madonna
-module(procnames).
-compile(export_all).
start() ->
P = processes(),
Expand Down
8 changes: 4 additions & 4 deletions lib/erl_interface/doc/src/erl_connect.xml
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ erl_xconnect( &addr , ALIVE );
<p>Initializes the <c><![CDATA[erl_connect]]></c> 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 <c>erl_connect</c>
be called before any of the other functions in the <c>erl_connect</c>
module are used.</p>
<p><c><![CDATA[erl_connect_xinit()]]></c> stores for later use
information about:</p>
Expand Down Expand Up @@ -196,7 +196,7 @@ erl_xconnect( &addr , ALIVE );
</item>
<item>
<p><c><![CDATA[node]]></c> is the node name. It is to
be of the form <em>alivename@hostname</em>.</p>
be of the form <em>alivename@hostname</em>.</p>
</item>
<item>
<p><c><![CDATA[addr]]></c> is the 32-bit IP address of
Expand All @@ -212,7 +212,7 @@ erl_xconnect( &addr , ALIVE );
<c><![CDATA[HOMEDRIVE]]></c> and
<c><![CDATA[HOMEPATH]]></c> variables on Windows. For more
details, see the <seealso marker="kernel:auth">
<c>kernel:auth</c></seealso> module.</p>
<c>auth</c></seealso> module in Kernel.</p>
</item>
<item>
<p><c><![CDATA[creation]]></c> helps identifying a particular
Expand Down Expand Up @@ -255,7 +255,7 @@ if (!erl_connect_init(17, "samplecookiestring...", 0))
</type>
<desc>
<p>This function is used by a server process to register
with the local name server <em>epmd</em>, 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 <c><![CDATA[bind()]]></c> and <c><![CDATA[listen()]]></c>
Expand Down
18 changes: 9 additions & 9 deletions lib/erl_interface/doc/src/erl_eterm.xml
Original file line number Diff line number Diff line change
Expand Up @@ -201,13 +201,13 @@ erl_free_compound(list);
</type>
<desc>
<p>Extracts a specified element from an Erlang tuple.</p>
<iist type="bulleted">
<list type="bulleted">
<item><c><![CDATA[position]]></c> specifies which element to retrieve
from <c><![CDATA[tuple]]></c>. The elements are numbered starting
from 1.</item>
<item><c><![CDATA[tuple]]></c> is an Erlang term containing at least
<c><![CDATA[position]]></c> elements.</item>
</iist>
</list>
<p>Returns a new Erlang term corresponding to the requested element, or
<c>NULL</c> if <c><![CDATA[position]]></c> was greater
than the arity of <c><![CDATA[tuple]]></c>.</p>
Expand Down Expand Up @@ -292,12 +292,12 @@ iohead ::= Binary

<func>
<name><ret>char *</ret><nametext>erl_iolist_to_string(list)</nametext></name>
<fsummary>Convert an I/O list to a zero-terminated string.</fsummary>
<fsummary>Convert an I/O list to a <c>NULL</c>-terminated string.</fsummary>
<type>
<v>ETERM *list;</v>
</type>
<desc>
<p>Converts an I/O list to a '\0' terminated C string.</p>
<p>Converts an I/O list to a <c>NULL</c>-terminated C string.</p>
<p><c><![CDATA[list]]></c> 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.</p>
Expand Down Expand Up @@ -344,14 +344,14 @@ iohead ::= Binary
contains a valid name for an atom.</p>
<p><c><![CDATA[ERL_ATOM_PTR(atom)]]></c> and
<c><![CDATA[ERL_ATOM_PTR_UTF8(atom)]]></c>
can be used to retrieve the atom name (as a null-terminated string).
can be used to retrieve the atom name (as a <c>NULL</c>-terminated string).
<c><![CDATA[ERL_ATOM_SIZE(atom)]]></c>
and <c><![CDATA[ERL_ATOM_SIZE_UTF8(atom)]]></c> return the length
of the atom name.</p>
<note>
<p>The UTF-8 variants were introduced in Erlang/OTP R16 and the
string returned by <c>ERL_ATOM_PTR(atom)</c> was not
null-terminated on older releases.</p>
<c>NULL</c>-terminated on older releases.</p>
</note>
</desc>
</func>
Expand Down Expand Up @@ -400,7 +400,7 @@ iohead ::= Binary
<p>Creates a list from a sequence of bytes.</p>
<list type="bulleted">
<item><c><![CDATA[string]]></c> is a buffer containing a sequence of
bytes. The buffer does not need to be zero-terminated.</item>
bytes. The buffer does not need to be <c>NULL</c>-terminated.</item>
<item><c><![CDATA[len]]></c> is the length of
<c><![CDATA[string]]></c>.</item>
</list>
Expand Down Expand Up @@ -586,8 +586,8 @@ iohead ::= Binary
<v>char *string;</v>
</type>
<desc>
<p>Creates a list from a zero-terminated string.</p>
<p><c><![CDATA[string]]></c> is the zero-terminated sequence of
<p>Creates a list from a <c>NULL</c>-terminated string.</p>
<p><c><![CDATA[string]]></c> is a <c>NULL</c>-terminated sequence of
characters
(that is, a C string) from which the list will be created.</p>
<p>Returns an Erlang list.</p>
Expand Down
4 changes: 2 additions & 2 deletions lib/erl_interface/doc/src/erl_format.xml
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ erl_format("[{name,~a},{age,~i},{data,~w}]",
</type>
<desc>
<p>This function is used to perform pattern matching similar
to that done in Erlang. For matching rules and more exemples, see
section <seealso marker="doc/reference_manual#patterns">
to that done in Erlang. For matching rules and more examples, see
section <seealso marker="doc/reference_manual:patterns">
Pattern Matching</seealso> in the Erlang Reference Manual.</p>
<list type="bulleted">
<item><c><![CDATA[Pattern]]></c> is an Erlang term, possibly
Expand Down
6 changes: 3 additions & 3 deletions lib/erl_interface/doc/src/erl_interface.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
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
distributed under the License is distributed on an "AS IS" BASIS,
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.

</legalnotice>

<title>The Erl_Interface Library</title>
Expand Down Expand Up @@ -500,7 +500,7 @@ erl_global_unregister(fd,servicename); ]]></code>
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.</p>
<p>Keys are strings, i.e. 0-terminated arrays of characters, and values
<p>Keys are strings, i.e. <c>NULL</c>-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.</p>
Expand Down
4 changes: 2 additions & 2 deletions lib/erl_interface/doc/src/erl_malloc.xml
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@
subterms associated with a specified Erlang term, regardless of
whether we are still holding pointers to the subterms.</p>
<p>For an example, see section
<seealso marker="building terms and patterns">Building Terms and
Patterns"></seealso> in the User's Guide.</p>
<seealso marker="building terms and patterns">Building Terms and Patterns</seealso>
in the User's Guide.</p>
</desc>
</func>

Expand Down
2 changes: 1 addition & 1 deletion lib/erl_interface/doc/src/erl_marshal.xml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
</list>
<p>Returns <c>0</c> if the terms are equal, <c>-1</c> if
<c>term1</c> &lt; <c>term2</c>, or <c>1</c> if <c>term2</c> &lt;
term1.</p>
<c>term1</c>.</p>
</desc>
</func>

Expand Down
5 changes: 2 additions & 3 deletions lib/erl_interface/doc/src/part_erl_interface.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
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
distributed under the License is distributed on an "AS IS" BASIS,
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.

</legalnotice>

<title>Erl_Interface User's Guide</title>
Expand All @@ -31,4 +31,3 @@
</header>
<xi:include href="erl_interface.xml"/>
</part>

5 changes: 2 additions & 3 deletions lib/erl_interface/doc/src/ref_man_erl_interface.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@
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
distributed under the License is distributed on an "AS IS" BASIS,
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.

</legalnotice>

<title>Erl_Interface Library Reference</title>
Expand Down Expand Up @@ -50,4 +50,3 @@
<xi:include href="erl_malloc.xml"/>
<xi:include href="erl_marshal.xml"/>
</application>

0 comments on commit 036c56d

Please sign in to comment.