From 8fbe76d64e7d55eb41943484602b928658313a65 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Tue, 11 Mar 2014 12:23:06 +0100
Subject: erts: Document external format for maps (MAP_EXT)

---
 erts/doc/src/erl_ext_dist.xml | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

(limited to 'erts/doc/src')

diff --git a/erts/doc/src/erl_ext_dist.xml b/erts/doc/src/erl_ext_dist.xml
index f91ed78122..9a53f3f829 100644
--- a/erts/doc/src/erl_ext_dist.xml
+++ b/erts/doc/src/erl_ext_dist.xml
@@ -5,7 +5,7 @@
   <header>
     <copyright>
       <year>2007</year>
-      <year>2013</year>
+      <year>2014</year>
       <holder>Ericsson AB, All Rights Reserved</holder>
     </copyright>
     <legalnotice>
@@ -572,6 +572,36 @@
 	</p>
     </section>
 
+    <section>
+      <marker id="MAP_EXT"/>
+      <title>MAP_EXT</title>
+
+	<table align="left">
+	  <row>
+	    <cell align="center">1</cell>
+	    <cell align="center">4</cell>
+	    <cell align="center">N</cell>
+	    <cell align="center">M</cell>
+	  </row>
+	  <row>
+	    <cell align="center">116</cell>
+	    <cell align="center">Arity</cell>
+	    <cell align="center">Keys</cell>
+	    <cell align="center">Values</cell>
+	  </row>
+	<tcaption></tcaption></table>
+	<p>
+	  <c>MAP_EXT</c> encodes a map. The <c>Arity</c> field is an unsigned
+	  4 byte integer in big endian format that determines the number of
+	  key-value pairs in the map. All key terms follow in the <c>Keys</c>
+	  section and then all value terms in the <c>Values</c> section. Keys
+	  and values are paired according to order; first key with first value
+	  and so on. Duplicate keys are <em>not allowed</em> within the same
+	  map.
+	</p>
+	<p><em>Since: </em>OTP 17.0</p>
+    </section>
+
     <section>
       <marker id="NIL_EXT"/>
       <title>NIL_EXT</title>
-- 
cgit v1.2.3


From c543d5bff7fb23c3f44cc4817c0654117de78919 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson <sverker@erlang.org>
Date: Wed, 12 Mar 2014 20:11:10 +0100
Subject: erts: Change external format for maps

to be: 116,Arity, K1,V1,K2,V2,...,Kn,Vn

instead of: 116,Arity, K1,K2,...,Kn, V1,V2,....,Vn

We think this will be better for future internal map structures
like HAMT. Would be bad if we need to iterate twice over HAMT
in term_to_binary, one for keys and one for values.
---
 erts/doc/src/erl_ext_dist.xml | 13 +++++--------
 1 file changed, 5 insertions(+), 8 deletions(-)

(limited to 'erts/doc/src')

diff --git a/erts/doc/src/erl_ext_dist.xml b/erts/doc/src/erl_ext_dist.xml
index 9a53f3f829..fa083db4c7 100644
--- a/erts/doc/src/erl_ext_dist.xml
+++ b/erts/doc/src/erl_ext_dist.xml
@@ -581,23 +581,20 @@
 	    <cell align="center">1</cell>
 	    <cell align="center">4</cell>
 	    <cell align="center">N</cell>
-	    <cell align="center">M</cell>
 	  </row>
 	  <row>
 	    <cell align="center">116</cell>
 	    <cell align="center">Arity</cell>
-	    <cell align="center">Keys</cell>
-	    <cell align="center">Values</cell>
+	    <cell align="center">Pairs</cell>
 	  </row>
 	<tcaption></tcaption></table>
 	<p>
 	  <c>MAP_EXT</c> encodes a map. The <c>Arity</c> field is an unsigned
 	  4 byte integer in big endian format that determines the number of
-	  key-value pairs in the map. All key terms follow in the <c>Keys</c>
-	  section and then all value terms in the <c>Values</c> section. Keys
-	  and values are paired according to order; first key with first value
-	  and so on. Duplicate keys are <em>not allowed</em> within the same
-	  map.
+	  key-value pairs in the map. Key and value pairs (<c>Ki => Vi</c>)
+	  are encoded in the <c>Pairs</c> section in the following order:
+	  <c>K1, V1, K2, V2,..., Kn, Vn</c>.
+	  Duplicate keys are <em>not allowed</em> within the same map.
 	</p>
 	<p><em>Since: </em>OTP 17.0</p>
     </section>
-- 
cgit v1.2.3