aboutsummaryrefslogtreecommitdiffstats
path: root/lib/megaco/doc
diff options
context:
space:
mode:
Diffstat (limited to 'lib/megaco/doc')
-rw-r--r--lib/megaco/doc/src/Makefile5
-rw-r--r--lib/megaco/doc/src/definitions/term.defs1
-rw-r--r--lib/megaco/doc/src/definitions/term.defs.xml7
-rw-r--r--lib/megaco/doc/src/megaco_encode.xml25
-rw-r--r--lib/megaco/doc/src/notes.xml188
5 files changed, 74 insertions, 152 deletions
diff --git a/lib/megaco/doc/src/Makefile b/lib/megaco/doc/src/Makefile
index f35413a4fd..ea2284e89b 100644
--- a/lib/megaco/doc/src/Makefile
+++ b/lib/megaco/doc/src/Makefile
@@ -1,7 +1,7 @@
#
# %CopyrightBegin%
#
-# Copyright Ericsson AB 2000-2012. All Rights Reserved.
+# Copyright Ericsson AB 2000-2013. All Rights Reserved.
#
# The contents of this file are subject to the Erlang Public License,
# Version 1.1, (the "License"); you may not use this file except in
@@ -123,9 +123,6 @@ imgs: $(IMG_FILES:%=$(HTMLDIR)/%)
man: $(MAN3_FILES)
$(INDEX_TARGET): $(INDEX_SRC) $(APP_FILE)
- sed -e 's/%VSN%/$(VSN)/' $< > $@
-
-$(INDEX_TARGET): $(INDEX_SRC) $(APP_FILE)
sed -e 's/%VSN%/$(VSN)/' \
-e 's/%ERLANG_SITE%/www\.erlang\.se\//' \
-e 's/%UP_ONE_LEVEL%/..\/..\/..\/doc\/index.html/' \
diff --git a/lib/megaco/doc/src/definitions/term.defs b/lib/megaco/doc/src/definitions/term.defs
index f3d6f865d2..57379eaa5d 100644
--- a/lib/megaco/doc/src/definitions/term.defs
+++ b/lib/megaco/doc/src/definitions/term.defs
@@ -110,7 +110,6 @@ the module Erlang in the application kernel","kenneth"},
{"Master Agent","Master Agent","The SNMP agent system consists of one Master Agent which terminates the SNMP protocol","mbj"}, {"MIB","Management Information Base (MIB)","An abstract definition of the management information available through a management interface in a system.","mbj"},
{"matching","matching","See pattern matching.","kenneth"},
{"message queue","message queue","The queue of not yet received messages that are in the mailbox of a process.","olin"},
-{"Mnemosyne","Mnemosyne","Mnemosyne was the query language of Mnesia up to the R11B release. Supersed by QLC.","hakan"},
{"Mnesia","Mnesia","Mnesia is a distributed Database Management System, appropriate for telecommunications applications and other applications with need of continuous operation and soft real-time properties.","hakan"},
{"MIBshort","MIB","See Management Information Base.","mbj"},
{"MIME","MIME","Multi-purpose Internet Mail Extensions.","jocke"},
diff --git a/lib/megaco/doc/src/definitions/term.defs.xml b/lib/megaco/doc/src/definitions/term.defs.xml
index 28ac0d6eaf..1c80ee8d80 100644
--- a/lib/megaco/doc/src/definitions/term.defs.xml
+++ b/lib/megaco/doc/src/definitions/term.defs.xml
@@ -794,13 +794,6 @@ The queue of not yet received messages that are in the mailbox of a process.
<resp>olin</resp>
</term>
<term>
- <id>Mnemosyne</id>
- <shortdef>Mnemosyne</shortdef>
- <def>
-Mnemosyne was the query language of Mnesia up to the R11B release. Supersed by QLC.</def>
- <resp>hakan</resp>
- </term>
- <term>
<id>Mnesia</id>
<shortdef>Mnesia</shortdef>
<def>
diff --git a/lib/megaco/doc/src/megaco_encode.xml b/lib/megaco/doc/src/megaco_encode.xml
index 410e4f3b31..4b5adab262 100644
--- a/lib/megaco/doc/src/megaco_encode.xml
+++ b/lib/megaco/doc/src/megaco_encode.xml
@@ -4,7 +4,7 @@
<chapter>
<header>
<copyright>
- <year>2000</year><year>2009</year>
+ <year>2000</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -224,22 +224,11 @@
messages.</p>
</item>
<item>
- <p>megaco_ber_bin_encoder - encode/decode ASN.1 BER
- messages. This encoder uses ASN.1 ber_bin which
- has been optimized using the bit syntax.</p>
- </item>
- <item>
<p>megaco_per_encoder - encode/decode ASN.1 PER
messages. N.B. that this format is not included in the
Megaco standard.</p>
</item>
<item>
- <p>megaco_per_bin_encoder - encode/decode ASN.1 PER
- messages. N.B. that this format is not included in the
- Megaco standard. This encoder uses ASN.1 per_bin which
- has been optimized using the bit syntax.</p>
- </item>
- <item>
<p>megaco_erl_dist_encoder - encodes messages into Erlangs
distribution format. It is rather verbose but encoding and
decoding is blinding fast. N.B. that this format is not
@@ -370,18 +359,6 @@
needs to be specified.</p>
<list type="bulleted">
<item>
- <p><c><![CDATA[[driver|_]]]></c> - make use of the asn1 driver for decode
- (ber_bin) and encode (per_bin). This option is only available for
- encoding modules: <c><![CDATA[megaco_binary_encoder]]></c>,
- <c><![CDATA[megaco_ber_bin_encoder]]></c> and <c><![CDATA[megaco_per_bin_encoder]]></c>.</p>
- <p>If this option is present in the encoding config, it <em>must</em>
- to be the <em>first</em>, unless the
- <seealso marker="#handling_versions">version3</seealso> encoding
- config is present, in which case it must come second, after
- the version3 encoding config,
- e.g. <c><![CDATA[[{version3,prev3b},driver]]]></c>.</p>
- </item>
- <item>
<p><c><![CDATA[[native]]]></c> - skips the transformation phase, i.e.
the decoded message(s) will not be transformed into our internal
form.</p>
diff --git a/lib/megaco/doc/src/notes.xml b/lib/megaco/doc/src/notes.xml
index e4efdf3dde..91905b76f7 100644
--- a/lib/megaco/doc/src/notes.xml
+++ b/lib/megaco/doc/src/notes.xml
@@ -36,10 +36,10 @@
section is the version number of Megaco.</p>
- <section><title>Megaco 3.16.1</title>
+ <section><title>Megaco 3.17</title>
- <p>Version 3.16.1 supports code replacement in runtime from/to
- version 3.16.0.2, 3.16.0.1, 3.16 and 3.15.1.1.</p>
+ <p>Version 3.17 supports code replacement in runtime from/to
+ version 3.16.0.3 and and 3.16.0.2. </p>
<section>
<title>Improvements and new features</title>
@@ -89,18 +89,82 @@
<!--
<list type="bulleted">
<item>
- <p>Due to the change in the flex driver API,
- we may no longer be able to build and/or use
- the flex driver without reentrant support. </p>
- <p>Own Id: OTP-9795</p>
+ <p>A number of binary encoding alternatives has been removed.
+ The binary encoding option <c>driver</c> has been removed
+ since this (the use of the asn1 linked in driver) is
+ now default and there is now way to <em>not</em> use it.
+ See <seealso marker="megaco_encode#binary_config">configuration of binary encoding</seealso> for more info. </p>
+ </item>
+
+ </list>
+-->
+
+ </section>
+
+ </section> <!-- 3.17 -->
+
+
+ <section><title>Megaco 3.16.0.3</title>
+
+ <p>Version 3.16.0.2 supports code replacement in runtime from/to
+ version 3.16.0.1, 3.16, 3.15.1.1, 3.15.1 and 3.15.</p>
+
+ <section>
+ <title>Improvements and new features</title>
+
+<!--
+ <p>-</p>
+-->
+
+ <list type="bulleted">
+ <item>
+ <p>Where necessary, a comment stating encoding has been
+ added to Erlang files. The comment is meant to be removed
+ in Erlang/OTP R17B when UTF-8 becomes the default encoding. </p>
+ <p>Own Id: OTP-10630</p>
</item>
+ </list>
+
+ </section>
+
+ <section>
+ <title>Fixed bugs and malfunctions</title>
+
+ <p>-</p>
+
+ <!--
+ <list type="bulleted">
+ <item>
+ <p>Fixing miscellaneous things detected by dialyzer. </p>
+ <p>Own Id: OTP-9075</p>
+ </item>
+
</list>
+ -->
+
+ </section>
+
+ <section>
+ <title>Incompatibilities</title>
+<!--
+ <p>-</p>
-->
+ <list type="bulleted">
+ <item>
+ <p>A number of binary encoding alternatives has been removed.
+ The binary encoding option <c>driver</c> has been removed
+ since this (the use of the asn1 linked in driver) is
+ now default and there is now way to <em>not</em> use it.
+ See <seealso marker="megaco_encode#binary_config">configuration of binary encoding</seealso> for more info. </p>
+ </item>
+
+ </list>
+
</section>
- </section> <!-- 3.16.1 -->
+ </section> <!-- 3.16.0.3 -->
<section><title>Megaco 3.16.0.2</title>
@@ -707,114 +771,6 @@
</section> <!-- 3.13 -->
- <section>
- <title>Megaco 3.12</title>
-
-<!--
- <p>Version 3.12 supports code replacement in runtime from/to
- version 3.11.3.</p>
--->
-
- <section>
- <title>Improvements and new features</title>
-<!--
- <p>-</p>
--->
-
- <list type="bulleted">
- <item>
- <p>Improve handling of async transaction reply. </p>
- <p>For asynchronous requests, issued using
- <seealso marker="megaco#cast">megaco:cast/3</seealso>,
- the reply will be delivered using the
- <seealso marker="megaco_user#trans_reply">handle_trans_reply/4,5</seealso>
- callback function. </p>
- <p>If a receiver of a request, issued using
- <seealso marker="megaco#cast">megaco:cast/3</seealso>,
- does not reply in time, megaco re-sends the request.
- If the receiver of the request sends the reply at the same
- time as megaco re-sends, it may also send a reply to the
- resent request (thinking the first reply got lost). These
- two replies may arrive more or less at the same time,
- causing confusion. </p>
- <p>In order to improve this situation, a number of
- improvements have been done: </p>
- <list type="bulleted">
- <item>
- <p>When the first reply arrives, a timer, request-keep-alive,
- is started. This timer is used to decide when to stop
- accepting replies as legitimate. </p>
- <p>The timeout time for the timer is specified by the
- config option <em>request_keep_alive_timout</em>,
- which can be set per
- <seealso marker="megaco#ui_request_keep_alive_timeout">user</seealso>
- or per
- <seealso marker="megaco#ci_request_keep_alive_timeout">connection</seealso>. </p>
- </item>
- <item>
- <p>We also keep track of how many replies has been received
- (we do this as long as the request-keep-alive timer is
- running). </p>
- </item>
- <item>
- <p>Each reply that arrives while the request-keep-alive timer
- is running (including the first) will be delivered using the
- <seealso marker="megaco_user#trans_reply">handle_trans_reply/4,5</seealso>
- callback function, but with the UserReply augmented to
- include a serial number indicating which reply number this
- is.
- The <em>first</em> reply to arrive,
- will be numbered <em>one (1)</em>. </p>
- </item>
- <item>
- <p>Replies arriving after the timer has expired will be delivered
- in the same way as before, using the
- <seealso marker="megaco_user#unexpected_trans">handle_unexpected_trans/3,4</seealso>
- callback function. </p>
- </item>
- <item>
- <p>Note that if the timer was <em>not</em> configured,
- megaco will act exactly as before! </p>
- </item>
- </list>
- <p>Own Id: OTP-8183</p>
- <p>Aux Id: Seq 11393</p>
- </item>
-
- </list>
-
- </section>
-
- <section>
- <title>Fixed bugs and malfunctions</title>
-<!--
- <p>-</p>
--->
-
- <list type="bulleted">
- <item>
- <p>If the megaco app received a transaction reply, for a request
- issued using the
- <seealso marker="megaco#call">call/3</seealso> function, from
- the wrong remote entity (wrong MId)), megaco would still deliver
- the reply (<seealso marker="megaco#call">call/3</seealso>
- returnes) as if from the correct remote entity (right MId). </p>
- <p>This has been changed so that the function now returns with
- an error reason. </p>
- <p>See <seealso marker="megaco#call">call/3</seealso> for more
- info. </p>
- <p>*** POTENTIAL INCOMPATIBILITY ***</p>
- <p>Own Id: OTP-8212</p>
- <p>Aux Id: Seq 11305</p>
- </item>
-
- </list>
-
- </section>
-
- </section> <!-- 3.12 -->
-
-
<!-- section>
<title>Release notes history</title>
<p>For information about older versions see