chan_pjsip: Transmit REFER waits for the REFER result setting TRANSFERSTATUS
[asterisk/asterisk.git] / doc / UPGRADE-staging / README.md
1 ## **DO NOT REMOVE THIS FILE!**
2
3 The only files that should be added to this directory are ones that will be
4 used by the release script to update the UPGRADE.txt file automatically. The
5 only time that it is necessary to add something to the UPGRADE-staging directory
6 is if you are making a breaking change to an existing feature in Asterisk. The
7 file does not need to have a meaningful name, but it probably should. If there
8 are multiple items that need documenting, you can add multiple files, each with
9 their own description. If the message is going to be the same for each subject,
10 then you can add multiple subject headers to one file. The "Subject: xxx" line
11 is case sensitive! For example, if you are making a change to PJSIP, then you
12 might add the file "res_pjsip_my_cool_feature" to this directory, with a short
13 description of what it does. If you are adding multiple entries, they should be
14 done in the same commit to avoid merge conflicts. Here's an example:
15
16 > Subject: res_pjsip
17 > Subject: Core
18 >
19 > Here's a pretty good description of my new feature that explains exactly what
20 > it does and how to use it.
21
22 Here's a master-only example:
23
24 > Subject: res_ari
25 > Master-Only: True
26 >
27 > This change will only go into the master branch. The "Master-Only" header
28 > will never be in a change not in master.
29
30 Note that the second subject has another header: "Master-Only". Changes that go
31 into the master branch and ONLY the master branch are the only ones that should
32 have this header. Also, the value can only be "true" or "True". The
33 "Master-Only" part of the header IS case-sensitive, however!
34
35 For more information, check out the wiki page:
36 https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt