Minor tweaks and spelling fixes for CHANGES and UPGRADE.txt.
[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 * The rarely used 'event_log' and LOG_EVENT channel have been removed; the few
24   users of this channel in the tree have been converted to LOG_NOTICE or removed
25   (in cases where the same message was already generated to another channel).
26
27 * The usage of RTP inside of Asterisk has now become modularized. This means
28   the Asterisk RTP stack now exists as a loadable module, res_rtp_asterisk.
29   If you are not using autoload=yes in modules.conf you will need to ensure
30   it is set to load. If not, then any module which uses RTP (such as chan_sip)
31   will not be able to send or receive calls.
32
33 * The app_dahdiscan.c file has been removed, but the dialplan app DAHDIScan still 
34   remains. It now exists within app_chanspy.c and retains the exact same 
35   functionality as before. 
36
37 From 1.6.1 to 1.6.2:
38
39 * The res_indications module has been removed.  Its functionality was important
40   enough that most of it has been moved into the Asterisk core.
41   Two applications previously provided by res_indications, PlayTones and
42   StopPlayTones, have been moved into a new module, app_playtones.
43
44 From 1.6.0.1 to 1.6.1:
45
46 * The ast_agi_register_multiple() and ast_agi_unregister_multiple()
47   API calls were added in 1.6.0, so that modules that provide multiple
48   AGI commands could register/unregister them all with a single
49   step. However, these API calls were not implemented properly, and did
50   not allow the caller to know whether registration or unregistration
51   succeeded or failed. They have been redefined to now return success
52   or failure, but this means any code using these functions will need
53   be recompiled after upgrading to a version of Asterisk containing
54   these changes. In addition, the source code using these functions
55   should be reviewed to ensure it can properly react to failure
56   of registration or unregistration of its API commands.
57
58 * The ast_agi_fdprintf() API call has been renamed to ast_agi_send()
59   to better match what it really does, and the argument order has been
60   changed to be consistent with other API calls that perform similar
61   operations.
62
63 From 1.6.0.x to 1.6.1:
64
65 * In previous versions of Asterisk, due to the way objects were arranged in
66   memory by chan_sip, the order of entries in sip.conf could be adjusted to
67   control the behavior of matching against peers and users.  The way objects
68   are managed has been significantly changed for reasons involving performance
69   and stability.  A side effect of these changes is that the order of entries
70   in sip.conf can no longer be relied upon to control behavior.
71
72 * The following core commands dealing with dialplan have been deprecated: 'core
73   show globals', 'core set global' and 'core set chanvar'. Use the equivalent
74   'dialplan show globals', 'dialplan set global' and 'dialplan set chanvar'
75   instead.
76
77 * In the dialplan expression parser, the logical value of spaces
78   immediately preceding a standalone 0 previously evaluated to
79   true. It now evaluates to false.  This has confused a good many
80   people in the past (typically because they failed to realize the
81   space had any significance).  Since this violates the Principle of
82   Least Surprise, it has been changed.
83
84 * While app_directory has always relied on having a voicemail.conf or users.conf file
85   correctly set up, it now is dependent on app_voicemail being compiled as well.
86
87 * SIP: All of the functionality in SIPCHANINFO() has been implemented in CHANNEL(),
88   and you should start using that function instead for retrieving information about
89   the channel in a technology-agnostic way.
90
91 * If you have any third party modules which use a config file variable whose
92   name ends in a '+', please note that the append capability added to this
93   version may now conflict with that variable naming scheme.  An easy
94   workaround is to ensure that a space occurs between the '+' and the '=',
95   to differentiate your variable from the append operator.  This potential
96   conflict is unlikely, but is documented here to be thorough.
97
98 * The "Join" event from app_queue now uses the CallerIDNum header instead of
99   the CallerID header to indicate the CallerID number.
100
101 From 1.6.1 to 1.6.2:
102
103 * The default console now will use colors according to the default background
104   color, instead of forcing the background color to black.  If you are using a
105   light colored background for your console, you may wish to use the option
106   flag '-W' to present better color choices for the various messages.  However,
107   if you'd prefer the old method of forcing colors to white text on a black
108   background, the compatibility option -B is provided for this purpose.
109
110 * SendImage() no longer hangs up the channel on transmission error or on
111   any other error; in those cases, a FAILURE status is stored in
112   SENDIMAGESTATUS and dialplan execution continues.  The possible
113   return values stored in SENDIMAGESTATUS are: SUCCESS, FAILURE, and
114   UNSUPPORTED. ('OK' has been replaced with 'SUCCESS', and 'NOSUPPORT'
115   has been replaced with 'UNSUPPORTED').  This change makes the
116   SendImage application more consistent with other applications.
117
118 * skinny.conf now has separate sections for lines and devices.
119   Please have a look at configs/skinny.conf.sample and update
120   your skinny.conf.
121
122 * Queue names previously were treated in a case-sensitive manner,
123   meaning that queues with names like "sales" and "sALeS" would be
124   seen as unique queues. The parsing logic has changed to use
125   case-insensitive comparisons now when originally hashing based on
126   queue names, meaning that now the two queues mentioned as examples
127   earlier will be seen as having the same name.
128
129 * The SPRINTF() dialplan function has been moved into its own module,
130   func_sprintf, and is no longer included in func_strings. If you use this
131   function and do not use 'autoload=yes' in modules.conf, you will need
132   to explicitly load func_sprintf for it to be available.