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