From 1717f3214a1a41950c0da9ca95c89824c4c9898f Mon Sep 17 00:00:00 2001
From: Anders Svensson
Date: Thu, 31 Aug 2017 10:34:14 +0200
Subject: Fix decode_format doc oversights
diameter_codec(3) referred only to the record format in places. The
configurable format was added in commits 722fa415 and then 55e65b26.
---
lib/diameter/doc/src/diameter_codec.xml | 18 +++++++++++-------
lib/diameter/doc/src/seealso.ent | 1 +
2 files changed, 12 insertions(+), 7 deletions(-)
(limited to 'lib/diameter/doc/src')
diff --git a/lib/diameter/doc/src/diameter_codec.xml b/lib/diameter/doc/src/diameter_codec.xml
index 0846334d23..5124b49484 100644
--- a/lib/diameter/doc/src/diameter_codec.xml
+++ b/lib/diameter/doc/src/diameter_codec.xml
@@ -4,7 +4,10 @@
'diameter_dict(4)'>
diameter_dict(4)'>
-
+ decode format'>
+
+
%also;
%here;
@@ -145,7 +148,8 @@ question.
The decoded value of an AVP.
Will be undefined on decode if the data bytes could
-not be decoded or the AVP is unknown.
+not be decoded, the AVP is unknown, or if the &decode_format; is
+none.
The type of a decoded value is as document in &types;.
@@ -243,8 +247,7 @@ Equivalently, a message can also be encoded as a list whose head is
the atom-valued message name (as specified in the relevant dictionary
file) and whose tail is either a list of AVP name/values
pairs or a map with values keyed on AVP names.
-The format at decode is determined by &mod_service_opt;
-decode_format.
+The format at decode is determined by &mod_decode_format;.
Any of the formats is accepted at encode.
@@ -288,15 +291,16 @@ value other than undefined.
-
The incoming/outgoing message.
-For an incoming message, a record if the message can be
-decoded in a non-relay application, undefined otherwise.
+For an incoming message, a term corresponding to the configured
+&decode_format; if the message can be decoded in a non-relay
+application, undefined otherwise.
For an outgoing message, setting a [&header; | &avp;] list is
equivalent to setting the header and avps fields to the
corresponding values.
-A record-valued msg field does not imply an absence of
+A value in the msg field does not imply an absence of
decode errors.
The errors field should also be examined.
diff --git a/lib/diameter/doc/src/seealso.ent b/lib/diameter/doc/src/seealso.ent
index ef6af1a3d0..c5a53670d0 100644
--- a/lib/diameter/doc/src/seealso.ent
+++ b/lib/diameter/doc/src/seealso.ent
@@ -72,6 +72,7 @@ significant.
watchdog_timer'>
diameter:service_opt() string_decode'>
+diameter:service_opt() decode_format'>
--
cgit v1.2.3