File 0142-erts-Convert-doc-note-to-section-Encoding-... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 0142-erts-Convert-doc-note-to-section-Encoding-atoms.patch of Package erlang (Revision 740810ae07adffc1a50bb3a32135aa98)

Currently displaying revision 740810ae07adffc1a50bb3a32135aa98 , Show latest

From b4ac3e1da84d690d3eece02e268a9890a294cce4 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Thu, 21 Oct 2021 13:47:02 +0200
Subject: [PATCH 2/2] erts: Convert doc note to section "Encoding atoms"

---
 erts/doc/src/erl_ext_dist.xml | 60 ++++++++++++++++++++---------------
 erts/doc/src/erlang.xml       | 13 ++------
 2 files changed, 38 insertions(+), 35 deletions(-)

diff --git a/erts/doc/src/erl_ext_dist.xml b/erts/doc/src/erl_ext_dist.xml
index f0bc4dfc70..a4fa3449cf 100644
--- a/erts/doc/src/erl_ext_dist.xml
+++ b/erts/doc/src/erl_ext_dist.xml
@@ -117,24 +117,34 @@
         <cell align="center"><c>Data</c></cell>
       </row>
     <tcaption>Compressed Data Format when Expanded</tcaption></table>
+  </section>
+
+  <section>
     <marker id="utf8_atoms"/>
-    <note>
-      <p>
-        As from ERTS 9.0 (OTP 20), atoms may contain any Unicode
-        characters. Atoms sent over node distribution are always encoded
-        in UTF-8 using either
-	<seeguide marker="#ATOM_UTF8_EXT"><c>ATOM_UTF8_EXT</c></seeguide>,
-        <seeguide marker="#SMALL_ATOM_UTF8_EXT"><c>SMALL_ATOM_UTF8_EXT</c></seeguide>
-        or <seeguide marker="#ATOM_CACHE_REF"><c>ATOM_CACHE_REF</c></seeguide>.
-        However, <seemfa marker="erts:erlang#term_to_binary/1">
-        <c>erlang:term_to_binary/1,2</c></seemfa> is by default still using the
-        old deprecated Latin-1 format
-        <seeguide marker="#ATOM_EXT"><c>ATOM_EXT</c></seeguide>
-        for atoms that only contain Latin-1 characters (Unicode code points 0-255).
-      </p>
-      <p>The maximum number of allowed characters in an atom is 255. In the
-        UTF-8 case, each character can need 4 bytes to be encoded.</p>
-    </note>
+    <title>Encoding atoms</title>
+    <p>
+      As from ERTS 9.0 (OTP 20), atoms may contain any Unicode characters.
+    </p>
+    <p>
+      Atoms sent over node distribution are always encoded in UTF-8 using
+      either <seeguide marker="#ATOM_UTF8_EXT"><c>ATOM_UTF8_EXT</c></seeguide>,
+      <seeguide marker="#SMALL_ATOM_UTF8_EXT"><c>SMALL_ATOM_UTF8_EXT</c></seeguide>
+      or <seeguide marker="#ATOM_CACHE_REF"><c>ATOM_CACHE_REF</c></seeguide>.
+    </p>
+    <p>
+      Atoms encoded with <seemfa marker="erts:erlang#term_to_binary/1">
+      <c>erlang:term_to_binary/1,2</c></seemfa> or
+      <seemfa marker="erts:erlang#term_to_iovec/1">
+      <c>erlang:term_to_iovec/1,2</c></seemfa> are by default still using the
+      old deprecated Latin-1 format
+      <seeguide marker="#ATOM_EXT"><c>ATOM_EXT</c></seeguide>
+      for atoms that only contain Latin-1 characters (Unicode code points
+      0-255). Atoms with higher code points will be encoded in UTF-8 using
+      either <seeguide marker="#ATOM_UTF8_EXT"><c>ATOM_UTF8_EXT</c></seeguide> or
+      <seeguide marker="#SMALL_ATOM_UTF8_EXT"><c>SMALL_ATOM_UTF8_EXT</c></seeguide>.
+    </p>
+    <p>The maximum number of allowed characters in an atom is 255. In the
+    UTF-8 case, each character can need 4 bytes to be encoded.</p>
   </section>
 
   <section>
@@ -284,8 +294,8 @@
       </p>
       <p>
         For more information on encoding of atoms, see the
-        <seeguide marker="#utf8_atoms">note on UTF-8 encoded atoms</seeguide>
-        in the beginning of this section.
+        <seeguide marker="#utf8_atoms">section on UTF-8 encoded atoms</seeguide>
+        above.
       </p>
       <p>
         If the <c>NewCacheEntryFlag</c> for the next <c>AtomCacheRef</c>
@@ -1363,9 +1373,9 @@
 	in UTF-8.
       </p>
       <p>
-	For more information on encoding of atoms, see the
-	<seeguide marker="#utf8_atoms">note on UTF-8 encoded atoms</seeguide>
-	in the beginning of this section.
+	For more information, see the
+	<seeguide marker="#utf8_atoms">section on encoding atoms</seeguide>
+	in the beginning of this page.
       </p>
     </section>
 
@@ -1391,9 +1401,9 @@
 	<seeguide marker="#ATOM_UTF8_EXT"><c>ATOM_UTF8_EXT</c></seeguide>.
       </p>
       <p>
-	For more information on encoding of atoms, see the
-	<seeguide marker="#utf8_atoms">note on UTF-8 encoded atoms</seeguide>
-	in the beginning of this section.
+	For more information, see the
+	<seeguide marker="#utf8_atoms">section on encoding atoms</seeguide>
+	in the beginning of this page.
       </p>
     </section>
 
diff --git a/erts/doc/src/erlang.xml b/erts/doc/src/erlang.xml
index 3b96ed5039..4ec5b38bf5 100644
--- a/erts/doc/src/erlang.xml
+++ b/erts/doc/src/erlang.xml
@@ -565,12 +565,8 @@ client(ServerPid, Request) ->
           valid UTF-8 sequences.</p>
         <note>
           <p>As from Erlang/OTP 20, <c>binary_to_atom(<anno>Binary</anno>, utf8)</c>
-            is capable of encoding any Unicode character. Earlier versions would
-            fail if the binary contained Unicode characters &gt; 255.
-            For more information about Unicode support in atoms, see the
-            <seeguide marker="erl_ext_dist#utf8_atoms">note on UTF-8
-            encoded atoms</seeguide>
-            in section "External Term Format" in the User's Guide.</p>
+            is capable of decoding any Unicode character. Earlier versions would
+            fail if the binary contained Unicode characters &gt; 255.</p>
         </note>
         <note>
           <p>The number of characters that are permitted in an atom
@@ -3233,10 +3229,7 @@ is_process_alive(P2Pid),
         <p>As from Erlang/OTP 20, <c><anno>String</anno></c> may contain
           any Unicode character. Earlier versions allowed only ISO-latin-1
           characters as the implementation did not allow Unicode characters
-          above 255. For more information on Unicode support in atoms, see
-          <seeguide marker="erl_ext_dist#utf8_atoms">note on UTF-8
-          encoded atoms</seeguide>
-        in section "External Term Format" in the User's Guide.</p>
+          above 255.</p>
         <note>
           <p>The number of characters that are permitted in an atom
           name is limited. The default limits can be found in the
-- 
2.31.1

Places

File 0142-erts-Convert-doc-note-to-section-Encoding-atoms.patch of Package erlang (Revision 740810ae07adffc1a50bb3a32135aa98)

Places