Rename 'canreinvite' option to 'directmedia', with backwards compatibility.
[asterisk/asterisk.git] / UPGRADE.txt
1 ===========================================================
2 ===
3 === Information for upgrading between Asterisk 1.6 versions
4 ===
5 === These files document all the changes that MUST be taken
6 === into account when upgrading between the Asterisk
7 === versions listed below. These changes may require that
8 === you modify your configuration files, dialplan or (in
9 === some cases) source code if you have your own Asterisk
10 === modules or patches. These files also includes advance
11 === notice of any functionality that has been marked as
12 === 'deprecated' and may be removed in a future release,
13 === along with the suggested replacement functionality.
14 ===
15 === UPGRADE-1.2.txt -- Upgrade info for 1.0 to 1.2
16 === UPGRADE-1.4.txt -- Upgrade info for 1.2 to 1.4
17 === UPGRADE-1.6.txt -- Upgrade info for 1.4 to 1.6
18 ===
19 ===========================================================
20
21 From 1.6.2 to 1.6.3:
22
23 * Asterisk-addons no longer exists as an independent package.  Those modules
24   now live in the addons directory of the main Asterisk source tree.  They
25   are not enabled by default.  For more information about why modules live in
26   addons, see README-addons.txt.
27
28 * The rarely used 'event_log' and LOG_EVENT channel have been removed; the few
29   users of this channel in the tree have been converted to LOG_NOTICE or removed
30   (in cases where the same message was already generated to another channel).
31
32 * The usage of RTP inside of Asterisk has now become modularized. This means
33   the Asterisk RTP stack now exists as a loadable module, res_rtp_asterisk.
34   If you are not using autoload=yes in modules.conf you will need to ensure
35   it is set to load. If not, then any module which uses RTP (such as chan_sip)
36   will not be able to send or receive calls.
37
38 * The app_dahdiscan.c file has been removed, but the dialplan app DAHDIScan still 
39   remains. It now exists within app_chanspy.c and retains the exact same 
40   functionality as before. 
41
42 From 1.6.1 to 1.6.2:
43
44 * The 'canreinvite' option support by the SIP, MGCP and Skinny channel drivers
45   has been renamed to 'directmedia', to better reflect what it actually does.
46   In the case of SIP, there are still re-INVITEs issued for T.38 negotiation,
47   starting and stopping music-on-hold, and other reasons, and the 'canreinvite'
48   option never had any effect on these cases, it only affected the re-INVITEs
49   used for direct media path setup. For MGCP and Skinny, the option was poorly
50   named because those protocols don't even use INVITE messages at all. For
51   backwards compatibility, the old option is still supported in both normal
52   and Realtime configuration files, but all of the sample configuration files,
53   Realtime/LDAP schemas, and other documentation refer to it using the new name.
54
55 * The default console now will use colors according to the default background
56   color, instead of forcing the background color to black.  If you are using a
57   light colored background for your console, you may wish to use the option
58   flag '-W' to present better color choices for the various messages.  However,
59   if you'd prefer the old method of forcing colors to white text on a black
60   background, the compatibility option -B is provided for this purpose.
61
62 * SendImage() no longer hangs up the channel on transmission error or on
63   any other error; in those cases, a FAILURE status is stored in
64   SENDIMAGESTATUS and dialplan execution continues.  The possible
65   return values stored in SENDIMAGESTATUS are: SUCCESS, FAILURE, and
66   UNSUPPORTED. ('OK' has been replaced with 'SUCCESS', and 'NOSUPPORT'
67   has been replaced with 'UNSUPPORTED').  This change makes the
68   SendImage application more consistent with other applications.
69
70 * skinny.conf now has separate sections for lines and devices.
71   Please have a look at configs/skinny.conf.sample and update
72   your skinny.conf.
73
74 * Queue names previously were treated in a case-sensitive manner,
75   meaning that queues with names like "sales" and "sALeS" would be
76   seen as unique queues. The parsing logic has changed to use
77   case-insensitive comparisons now when originally hashing based on
78   queue names, meaning that now the two queues mentioned as examples
79   earlier will be seen as having the same name.
80
81 * The SPRINTF() dialplan function has been moved into its own module,
82   func_sprintf, and is no longer included in func_strings. If you use this
83   function and do not use 'autoload=yes' in modules.conf, you will need
84   to explicitly load func_sprintf for it to be available.
85
86 * The res_indications module has been removed.  Its functionality was important
87   enough that most of it has been moved into the Asterisk core.
88   Two applications previously provided by res_indications, PlayTones and
89   StopPlayTones, have been moved into a new module, app_playtones.
90
91 * Support for Taiwanese was incorrectly supported with the "tw" language code.
92   In reality, the "tw" language code is reserved for the Twi language, native
93   to Ghana.  If you were previously using the "tw" language code, you should
94   switch to using either "zh" (for Mandarin Chinese) or "zh_TW" for Taiwan
95   specific localizations.  Additionally, "mx" should be changed to "es_MX",
96   Georgian was incorrectly specified as "ge" but should be "ka", and Czech is
97   "cs", not "cz".
98
99 From 1.6.0.1 to 1.6.1:
100
101 * The ast_agi_register_multiple() and ast_agi_unregister_multiple()
102   API calls were added in 1.6.0, so that modules that provide multiple
103   AGI commands could register/unregister them all with a single
104   step. However, these API calls were not implemented properly, and did
105   not allow the caller to know whether registration or unregistration
106   succeeded or failed. They have been redefined to now return success
107   or failure, but this means any code using these functions will need
108   be recompiled after upgrading to a version of Asterisk containing
109   these changes. In addition, the source code using these functions
110   should be reviewed to ensure it can properly react to failure
111   of registration or unregistration of its API commands.
112
113 * The ast_agi_fdprintf() API call has been renamed to ast_agi_send()
114   to better match what it really does, and the argument order has been
115   changed to be consistent with other API calls that perform similar
116   operations.
117
118 From 1.6.0.x to 1.6.1:
119
120 * In previous versions of Asterisk, due to the way objects were arranged in
121   memory by chan_sip, the order of entries in sip.conf could be adjusted to
122   control the behavior of matching against peers and users.  The way objects
123   are managed has been significantly changed for reasons involving performance
124   and stability.  A side effect of these changes is that the order of entries
125   in sip.conf can no longer be relied upon to control behavior.
126
127 * The following core commands dealing with dialplan have been deprecated: 'core
128   show globals', 'core set global' and 'core set chanvar'. Use the equivalent
129   'dialplan show globals', 'dialplan set global' and 'dialplan set chanvar'
130   instead.
131
132 * In the dialplan expression parser, the logical value of spaces
133   immediately preceding a standalone 0 previously evaluated to
134   true. It now evaluates to false.  This has confused a good many
135   people in the past (typically because they failed to realize the
136   space had any significance).  Since this violates the Principle of
137   Least Surprise, it has been changed.
138
139 * While app_directory has always relied on having a voicemail.conf or users.conf file
140   correctly set up, it now is dependent on app_voicemail being compiled as well.
141
142 * SIP: All of the functionality in SIPCHANINFO() has been implemented in CHANNEL(),
143   and you should start using that function instead for retrieving information about
144   the channel in a technology-agnostic way.
145
146 * If you have any third party modules which use a config file variable whose
147   name ends in a '+', please note that the append capability added to this
148   version may now conflict with that variable naming scheme.  An easy
149   workaround is to ensure that a space occurs between the '+' and the '=',
150   to differentiate your variable from the append operator.  This potential
151   conflict is unlikely, but is documented here to be thorough.
152
153 * The "Join" event from app_queue now uses the CallerIDNum header instead of
154   the CallerID header to indicate the CallerID number.
155
156 * If you use ODBC storage for voicemail, there is a new field called "flag"
157   which should be a char(8) or larger.  This field specifies whether or not a
158   message has been designated to be "Urgent", "PRIORITY", or not.
159