From 55e65b262cdf0b794ab443928676720a323cf6b0 Mon Sep 17 00:00:00 2001
From: Anders Svensson <anders@erlang.org>
Date: Sat, 8 Jul 2017 00:48:07 +0200
Subject: Rename record_decode -> decode_format

{record_decode, map} is a bit too quirky.
---
 lib/diameter/doc/src/diameter.xml | 48 +++++++++++++++++++--------------------
 1 file changed, 23 insertions(+), 25 deletions(-)

(limited to 'lib/diameter/doc/src/diameter.xml')

diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index e525ab3345..a7f001e096 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -797,6 +797,29 @@ be matched by corresponding &capability; configuration, of
 
 </item>
 
+<tag>
+<marker id="decode_format"/>
+<c>{decode_format, record | list | map | false}</c></tag>
+<item>
+<p>
+The type of decoded messages and grouped AVPs in the <c>msg</c> field
+of diameter_packet records and <c>value</c> field of diameter_avp
+records respectively.
+If <c>false</c> then the fields are set this value.
+See also &codec_message;.</p>
+
+<p>
+Defaults to <c>record</c>.</p>
+
+<note>
+<p>
+AVPs are decoded into a list of diameter_avp records in <c>avps</c>
+field of diameter_packet records independently of
+<c>decode_format</c>.</p>
+</note>
+
+</item>
+
 <tag>
 <marker id="incoming_maxlen"/><c>{incoming_maxlen, 0..16777215}</c></tag>
 <item>
@@ -969,31 +992,6 @@ occur in the message in question.</p>
 
 </item>
 
-<tag>
-<marker id="record_decode"/>
-<c>{record_decode, boolean() | list | map}</c></tag>
-<item>
-<p>
-Whether or not to decode message and grouped AVPs to records in the
-<c>msg</c> field of diameter_packet records and <c>value</c> field of
-diameter_avp records respectively, or to an alternate format.
-If false then the fields are set to the same value.
-See also &codec_message;.</p>
-
-<p>
-Defaults to <c>true</c>.</p>
-
-<note>
-<p>
-Disabling the record is useful for applications in which the records
-aren't used/needed.
-AVP values are available in the <c>avps</c> field of
-diameter_packet records regardless of whether or not there is a record
-decode.</p>
-</note>
-
-</item>
-
 <tag>
 <marker id="string_decode"/><c>{string_decode, boolean()}</c></tag>
 <item>
-- 
cgit v1.2.3