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