File 4317-megaco-doc-Removed-all-mention-on-the-prev... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 4317-megaco-doc-Removed-all-mention-on-the-prev3X-codec-s.patch of Package erlang (Revision 1e94e72e3f4fed1ca9cd5c2fd777ed02)

Currently displaying revision 1e94e72e3f4fed1ca9cd5c2fd777ed02 , Show latest

From 9a98883a9542a26256507a2bc7aef1f4dc818b40 Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Fri, 20 Mar 2020 09:42:22 +0100
Subject: [PATCH 7/8] [megaco|doc] Removed all mention on the prev3X codec(s)

The prev3X codec(s) are removed in this version (24) of OTP.

OTP-16560
---
 lib/megaco/doc/src/megaco_encode.xml | 57 +++++-----------------------
 lib/megaco/doc/src/megaco_run.xml    |  3 +-
 2 files changed, 10 insertions(+), 50 deletions(-)

diff --git a/lib/megaco/doc/src/megaco_encode.xml b/lib/megaco/doc/src/megaco_encode.xml
index 0e8485762b..fb13ddc338 100644
--- a/lib/megaco/doc/src/megaco_encode.xml
+++ b/lib/megaco/doc/src/megaco_encode.xml
@@ -379,46 +379,6 @@
 <section>
 <marker id="handling_versions"></marker>
 <title>Handling megaco versions</title>
- <note>
- This version (still) include three <c>pre version 3</c> variants of
- the version 3 codec, beside the proper version 3.
- These versions, <c>prev3a | prev3b | prev3c</c>,
- are deprecated, and will be removed in OTP 24. 
- </note>
- To be able to specify the different variants of version 3,
- the encoding config option <c><![CDATA[{version3, version3()}]]></c>
- still exists. This option, if present, has to be first
- in the encoding config list. Version 1 and 2 codec's ignore this option,
- if found. 
- <code type="none"><![CDATA[
-version3() -> prev3a | prev3b | prev3c | v3 ]]></code>
- <list type="bulleted">
- <item>
- DEPRECATED: prev3a
- Preliminary version 3, based on TD-33
- </item>
- <item>
- DEPRECATED: prev3b
- Preliminary version 3, based on TD-33, but text encoding 
- updated with the final solution for priority in 
- <c><![CDATA[contextProperty]]></c> (which is backward compatible with 
-v2).
- </item>
- <item>
- DEPRECATED: prev3c
- Preliminary version 3, based on the final version of the 
- v3-standard, but excluding segments!
- </item>
- <item>
- v3
- Full version 3. Including segmentation. This is the default
- version 3 variant (i.e. if a version 3 messages is to be 
- encoded/decoded and no version3 encoding config is found, 
- then v3 is assumed).
- </item>
- </list>
-
-
 There are two ways to handle the different megaco encoding versions.
 Either using dynamic version detection (only valid for
 for incoming messages) or by explicit version setting in 
@@ -439,10 +399,10 @@ v2).
 Explicit version
 Explicitly set the actual protocol version in the 
 megaco_receive_handle.
- Start with version 1. When the initial service change has been 
- performed and version 2 has been negotiated, upgrade the 
- megaco_receive_handle of the transport process (control_pid) to 
- version 2.
+ Start with version 1.
+	 When the initial service change has been performed and version 2
+	 has been negotiated, upgrade the megaco_receive_handle of the
+	 transport process (control_pid) to version 2.
 See 
 <seeerl marker="megaco_tcp#upgrade_receive_handle">megaco_tcp</seeerl>
 and 
@@ -450,10 +410,11 @@ v2).
 Note that if <c><![CDATA[udp]]></c> is used, the same transport process 
 could be used for several connections. This could make upgrading 
 impossible.
- For codecs that does not support partial decode of the version, 
- currently <c><![CDATA[megaco_ber_encoder]]></c>, <c><![CDATA[megaco_per_encoder]]></c>
- and <c><![CDATA[megaco_per_bin_encoder]]></c>, <c><![CDATA[dynamic]]></c> will revert to 
- version 1.
+ For codecs that does not support partial decode of
+	 the version, 
+ currently <c><![CDATA[megaco_ber_encoder]]></c> and
+	 <c><![CDATA[megaco_per_encoder]]></c>, 
+ <c><![CDATA[dynamic]]></c> will revert to version 1.
 </item>
 </list>
 For outgoing messages:
diff --git a/lib/megaco/doc/src/megaco_run.xml b/lib/megaco/doc/src/megaco_run.xml
index 4803b2d7d5..139aecf558 100644
--- a/lib/megaco/doc/src/megaco_run.xml
+++ b/lib/megaco/doc/src/megaco_run.xml
@@ -328,8 +328,7 @@
 <c>segmentation package</c> was introduced.
 Simply, this package defines a procedure to segment 
 megaco messages (transaction replies) when using a transport that 
- does not automatically do this (e.g. UDP). See also
- <seeguide marker="megaco_encode#handling_versions">version3</seeguide>.
+ does not automatically do this (e.g. UDP).
 Although it would be both pointless and counterproductive to use
 segmentation on a transport that already does this (e.g. TCP), the 
 megaco application does not check this. Instead, it is up to the 
-- 
2.26.2

Places

File 4317-megaco-doc-Removed-all-mention-on-the-prev3X-codec-s.patch of Package erlang (Revision 1e94e72e3f4fed1ca9cd5c2fd777ed02)

Places