From c596e17cf3d69cf5e10d28ee2a8ee35162786da1 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Wed, 23 Jan 2013 16:04:38 +0100
Subject: erl_interface: Changed erlang_char_encoding interface

to allow bitwise-or'd combinations.
---
 lib/erl_interface/doc/src/ei.xml | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

(limited to 'lib/erl_interface/doc/src')

diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml
index e9c7c644b5..117c787da6 100644
--- a/lib/erl_interface/doc/src/ei.xml
+++ b/lib/erl_interface/doc/src/ei.xml
@@ -91,14 +91,13 @@
 	 <p/>
 	 <code type="none">
 enum erlang_char_encoding {
-    ERLANG_ASCII, ERLANG_LATIN1, ERLANG_UTF8, ERLANG_WHATEVER
+    ERLANG_ASCII, ERLANG_LATIN1, ERLANG_UTF8
 };
 </code>
          <p>The character encoding used for atoms. <c>ERLANG_ASCII</c> represents 7-bit ASCII.
 	 Latin1 and UTF8 are different extensions of 7-bit ASCII. All 7-bit ASCII characters
 	 are valid Latin1 and UTF8 characters. ASCII and Latin1 both represent each character
-	 by one byte. A UTF8 character can consist of one to four bytes. <c>ERLANG_WHATEVER</c>
-	 is not an encoding but rather used as a wildcard.</p>
+	 by one byte. A UTF8 character can consist of one to four bytes.</p>
       </item>
     </taglist>
   </section>
@@ -545,11 +544,13 @@ ei_x_encode_empty_list(&amp;x);
 	want</seealso></c>. The original encoding used in the
 	binary format (latin1 or utf8) can be obtained from <c>*was</c>. The actual encoding of the resulting string
 	(7-bit ascii, latin1 or utf8) can be obtained from <c>*result</c>. Both <c>was</c> and <c>result</c> can be <c>NULL</c>.
-	<c>*result</c> may differ from <c>want</c> if <c>want</c> is <c>ERLANG_WHATEVER</c> or if
-	<c>*result</c> turn out to be pure 7-bit ascii (compatible with both latin1 and utf8).</p>
+	
+	<c>*result</c> may differ from <c>want</c> if <c>want</c> is a bitwise-or'd combination like
+	<c>ERLANG_LATIN1|ERLANG_UTF8</c> or if <c>*result</c> turn out to be pure 7-bit ascii
+	(compatible with both latin1 and utf8).</p>
 	<p>This function fails if the atom is too long for the buffer
 	or if it can not be represented with encoding <c>want</c>.</p>
-	<p>This functions was introduced in R16 release of Erlang/OTP as part of a first step
+	<p>This function was introduced in R16 release of Erlang/OTP as part of a first step
 	to support UTF8 atoms.</p>
       </desc>
     </func>
-- 
cgit v1.2.3