<p>Benjamin Keith Ford has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.asterisk.org/10943">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">build: Revise CHANGES and UPGRADE.txt handling.<br><br>This changes the way that we handle adding changes to CHANGES and<br>UPGRADE.txt. The reason for this is because whenever someone needed to<br>make a changes to one of these files and someone else had already done<br>so, you would run into merge conflicts. With this new setup, there will<br>never be merge conflicts since all changes will be documented in the<br>doc/<file>-staging directory. The release script is now responsible for<br>merging all of these changes into the appropriate files.<br><br>There is a special format that these files have to follow in order to be<br>parsed. The files do not need to have a meaningful name, but it is<br>strongly recommended. For example, if you made a change to pjsip, you<br>may have something like this "res_pjsip_relative_title", where<br>"relative_title" is something more descriptive than that. Inside each<br>file, you will need a subject line for your change, followed by a<br>description. There can be multiple subject lines. The file may look<br>something like this:<br><br> Subject: res_pjsip<br><br> A description that explains the changes made and why. The release<br> script will handle the bulleting and section separators!<br><br> You can still separate with new lines within your description.<br><br> Subject: res_pjsip<br><br> You can have more than one subject!<br><br> Subject: Core<br><br> The subjects don't have to be the same.<br><br>The headers (Subject:) are case sensative.<br><br>For more information, check out the wiki page:<br>https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt<br><br>Change-Id: I19cf4b569321c88155a65e9b0b80f6d58075dd47<br>---<br>M CHANGES<br>A doc/CHANGES-staging/README<br>A doc/CHANGES-staging/app_voicemail_aliasescontext<br>A doc/CHANGES-staging/features_automon_automixmon<br>A doc/CHANGES-staging/res_pjsip_send_contact_status_on_update_registration<br>A doc/UPGRADE-staging/README<br>6 files changed, 65 insertions(+), 28 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/43/10943/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/CHANGES b/CHANGES</span><br><span>index 51b9b58..6e87611 100644</span><br><span>--- a/CHANGES</span><br><span>+++ b/CHANGES</span><br><span>@@ -9,34 +9,6 @@</span><br><span> ==============================================================================</span><br><span> </span><br><span> ------------------------------------------------------------------------------</span><br><span>---- Functionality changes from Asterisk 13.24.0 to Asterisk 13.25.0 ----------</span><br><span>-------------------------------------------------------------------------------</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-res_pjsip</span><br><span>-------------------</span><br><span style="color: hsl(0, 100%, 40%);">- * Added "send_contact_status_on_update_registration" global configuration option</span><br><span style="color: hsl(0, 100%, 40%);">- to enable sending AMI ContactStatus event when a device refreshes its registration.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-Features</span><br><span>-------------------</span><br><span style="color: hsl(0, 100%, 40%);">- * Before Asterisk 12, when using the automon or automixmon features defined</span><br><span style="color: hsl(0, 100%, 40%);">- in features.conf, a channel variable (TOUCH_MIXMONITOR_OUTPUT) was set on</span><br><span style="color: hsl(0, 100%, 40%);">- both channels, indicating the filename of the recording.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- When bridging was overhauled in Asterisk 12, the behavior was changed such</span><br><span style="color: hsl(0, 100%, 40%);">- that the variable was only set on the peer channel and not on the channel</span><br><span style="color: hsl(0, 100%, 40%);">- that initiated the automon or automixmon.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- The previous behavior has been restored so both channels receive the</span><br><span style="color: hsl(0, 100%, 40%);">- channel variable when one of these features is invoked.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">-app_voicemail</span><br><span>-------------------</span><br><span style="color: hsl(0, 100%, 40%);">- * You can now specify a special context with the "aliasescontext" parameter</span><br><span style="color: hsl(0, 100%, 40%);">- in voicemail.conf which will allow you to create aliases for physical</span><br><span style="color: hsl(0, 100%, 40%);">- mailboxes.</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span>-------------------------------------------------------------------------------</span><br><span> --- Functionality changes from Asterisk 13.23.0 to Asterisk 13.24.0 ----------</span><br><span> ------------------------------------------------------------------------------</span><br><span> </span><br><span>diff --git a/doc/CHANGES-staging/README b/doc/CHANGES-staging/README</span><br><span>new file mode 100644</span><br><span>index 0000000..9c3c79f</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/README</span><br><span>@@ -0,0 +1,22 @@</span><br><span style="color: hsl(120, 100%, 40%);">+DO NOT REMOVE THIS FILE!</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The only files that should be added to this directory are ones that will be</span><br><span style="color: hsl(120, 100%, 40%);">+used by the release script to update the CHANGES file automatically. The only</span><br><span style="color: hsl(120, 100%, 40%);">+time that it is necessary to add something to the CHANGES-staging directory is</span><br><span style="color: hsl(120, 100%, 40%);">+if you are either adding a new feature to Asterisk or adding new functionality</span><br><span style="color: hsl(120, 100%, 40%);">+to an existing feature. The file does not need to have a meaningful name, but</span><br><span style="color: hsl(120, 100%, 40%);">+it probably should. If there are multiple items that need documenting, each can</span><br><span style="color: hsl(120, 100%, 40%);">+be separated with a subject line, which should always start with "SUBJECT:",</span><br><span style="color: hsl(120, 100%, 40%);">+followed by the subject of the change. For example, if you are making a change</span><br><span style="color: hsl(120, 100%, 40%);">+to PJSIP, then you might add the file "res_pjsip_my_cool_feature" to this</span><br><span style="color: hsl(120, 100%, 40%);">+directory, with a short description of what it does. Here's an example:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+SUBJECT: res_pjsip</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Here's a pretty good description of my new feature that explains exactly what</span><br><span style="color: hsl(120, 100%, 40%);">+it does and how to use it.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+SUBJECT: core</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Here's another description of something else I added that is a big enough</span><br><span style="color: hsl(120, 100%, 40%);">+change to warrant another entry in the CHANGES file.</span><br><span>diff --git a/doc/CHANGES-staging/app_voicemail_aliasescontext b/doc/CHANGES-staging/app_voicemail_aliasescontext</span><br><span>new file mode 100644</span><br><span>index 0000000..e56dabd</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/app_voicemail_aliasescontext</span><br><span>@@ -0,0 +1,5 @@</span><br><span style="color: hsl(120, 100%, 40%);">+Subject: app_voicemail</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+You can now specify a special context with the "aliasescontext" parameter</span><br><span style="color: hsl(120, 100%, 40%);">+in voicemail.conf which will allow you to create aliases for physical</span><br><span style="color: hsl(120, 100%, 40%);">+mailboxes.</span><br><span>diff --git a/doc/CHANGES-staging/features_automon_automixmon b/doc/CHANGES-staging/features_automon_automixmon</span><br><span>new file mode 100644</span><br><span>index 0000000..b97c883</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/features_automon_automixmon</span><br><span>@@ -0,0 +1,12 @@</span><br><span style="color: hsl(120, 100%, 40%);">+Subject: Features</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Before Asterisk 12, when using the automon or automixmon features defined</span><br><span style="color: hsl(120, 100%, 40%);">+in features.conf, a channel variable (TOUCH_MIXMONITOR_OUTPUT) was set on</span><br><span style="color: hsl(120, 100%, 40%);">+both channels, indicating the filename of the recording.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+When bridging was overhauled in Asterisk 12, the behavior was changed such</span><br><span style="color: hsl(120, 100%, 40%);">+that the variable was only set on the peer channel and not on the channel</span><br><span style="color: hsl(120, 100%, 40%);">+that initiated the automon or automixmon.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The previous behavior has been restored so both channels receive the</span><br><span style="color: hsl(120, 100%, 40%);">+channel variable when one of these features is invoked.</span><br><span>diff --git a/doc/CHANGES-staging/res_pjsip_send_contact_status_on_update_registration b/doc/CHANGES-staging/res_pjsip_send_contact_status_on_update_registration</span><br><span>new file mode 100644</span><br><span>index 0000000..e27a0c0</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/res_pjsip_send_contact_status_on_update_registration</span><br><span>@@ -0,0 +1,4 @@</span><br><span style="color: hsl(120, 100%, 40%);">+Subject: res_pjsip</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Added "send_contact_status_on_update_registration" global configuration option</span><br><span style="color: hsl(120, 100%, 40%);">+to enable sending AMI ContactStatus event when a device refreshes its registration.</span><br><span>diff --git a/doc/UPGRADE-staging/README b/doc/UPGRADE-staging/README</span><br><span>new file mode 100644</span><br><span>index 0000000..95ec1ff</span><br><span>--- /dev/null</span><br><span>+++ b/doc/UPGRADE-staging/README</span><br><span>@@ -0,0 +1,22 @@</span><br><span style="color: hsl(120, 100%, 40%);">+DO NOT REMOVE THIS FILE!</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The only files that should be added to this directory are ones that will be</span><br><span style="color: hsl(120, 100%, 40%);">+used by the release script to update the UPGRADE.txt file automatically. The</span><br><span style="color: hsl(120, 100%, 40%);">+only time that it is necessary to add something to the UPGRADE-staging directory</span><br><span style="color: hsl(120, 100%, 40%);">+is if you are making a breaking change to an existing feature in Asterisk. The</span><br><span style="color: hsl(120, 100%, 40%);">+file does not need to have a meaningful name, but it probably should. If there</span><br><span style="color: hsl(120, 100%, 40%);">+are multiple items that need documenting, each can be separated with a subject</span><br><span style="color: hsl(120, 100%, 40%);">+line, which should always start with "SUBJECT:", followed by the subject of the</span><br><span style="color: hsl(120, 100%, 40%);">+change. For example, if you are making a change to PJSIP, then you might add the</span><br><span style="color: hsl(120, 100%, 40%);">+file "res_pjsip_breaking_change" to this directory, with a short description of</span><br><span style="color: hsl(120, 100%, 40%);">+what it does. Here's an example:</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+SUBJECT: res_pjsip</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Here's a pretty good description of what I changed that explains exactly what</span><br><span style="color: hsl(120, 100%, 40%);">+it does and why it breaks things (and why they needed to be broken).</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+SUBJECT: core</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+Here's another description of something else I added that is a big enough</span><br><span style="color: hsl(120, 100%, 40%);">+change to warrant another entry in the UPDATE.txt file.</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/10943">change 10943</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/10943"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 13 </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>
<div style="display:none"> Gerrit-Change-Id: I19cf4b569321c88155a65e9b0b80f6d58075dd47 </div>
<div style="display:none"> Gerrit-Change-Number: 10943 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Benjamin Keith Ford <bford@digium.com> </div>