[Asterisk-code-review] build: Revise CHANGES and UPGRADE.txt handling. (asterisk[13])

Fri Feb 1 12:09:30 CST 2019

Benjamin Keith Ford has uploaded this change for review. ( https://gerrit.asterisk.org/10943


Change subject: build: Revise CHANGES and UPGRADE.txt handling.
......................................................................

build: Revise CHANGES and UPGRADE.txt handling.

This changes the way that we handle adding changes to CHANGES and
UPGRADE.txt. The reason for this is because whenever someone needed to
make a changes to one of these files and someone else had already done
so, you would run into merge conflicts. With this new setup, there will
never be merge conflicts since all changes will be documented in the
doc/<file>-staging directory. The release script is now responsible for
merging all of these changes into the appropriate files.

There is a special format that these files have to follow in order to be
parsed. The files do not need to have a meaningful name, but it is
strongly recommended. For example, if you made a change to pjsip, you
may have something like this "res_pjsip_relative_title", where
"relative_title" is something more descriptive than that. Inside each
file, you will need a subject line for your change, followed by a
description. There can be multiple subject lines. The file may look
something like this:

   Subject: res_pjsip

   A description that explains the changes made and why. The release
   script will handle the bulleting and section separators!

   You can still separate with new lines within your description.

   Subject: res_pjsip

   You can have more than one subject!

   Subject: Core

   The subjects don't have to be the same.

The headers (Subject:) are case sensative.

For more information, check out the wiki page:
https://wiki.asterisk.org/wiki/display/AST/CHANGES+and+UPGRADE.txt

Change-Id: I19cf4b569321c88155a65e9b0b80f6d58075dd47
---
M CHANGES
A doc/CHANGES-staging/README
A doc/CHANGES-staging/app_voicemail_aliasescontext
A doc/CHANGES-staging/features_automon_automixmon
A doc/CHANGES-staging/res_pjsip_send_contact_status_on_update_registration
A doc/UPGRADE-staging/README
6 files changed, 65 insertions(+), 28 deletions(-)



  git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/43/10943/1

diff --git a/CHANGES b/CHANGES
index 51b9b58..6e87611 100644
--- a/CHANGES
+++ b/CHANGES
@@ -9,34 +9,6 @@
 ==============================================================================
 
 ------------------------------------------------------------------------------
---- Functionality changes from Asterisk 13.24.0 to Asterisk 13.25.0 ----------
-------------------------------------------------------------------------------
-
-res_pjsip
-------------------
- * Added "send_contact_status_on_update_registration" global configuration option
-   to enable sending AMI ContactStatus event when a device refreshes its registration.
-
-Features
-------------------
- * Before Asterisk 12, when using the automon or automixmon features defined
-   in features.conf, a channel variable (TOUCH_MIXMONITOR_OUTPUT) was set on
-   both channels, indicating the filename of the recording.
-
-   When bridging was overhauled in Asterisk 12, the behavior was changed such
-   that the variable was only set on the peer channel and not on the channel
-   that initiated the automon or automixmon.
-
-   The previous behavior has been restored so both channels receive the
-   channel variable when one of these features is invoked.
-
-app_voicemail
-------------------
- * You can now specify a special context with the "aliasescontext" parameter
-   in voicemail.conf which will allow you to create aliases for physical
-   mailboxes.
-
-------------------------------------------------------------------------------
 --- Functionality changes from Asterisk 13.23.0 to Asterisk 13.24.0 ----------
 ------------------------------------------------------------------------------
 
diff --git a/doc/CHANGES-staging/README b/doc/CHANGES-staging/README
new file mode 100644
index 0000000..9c3c79f
--- /dev/null
+++ b/doc/CHANGES-staging/README
@@ -0,0 +1,22 @@
+DO NOT REMOVE THIS FILE!
+
+The only files that should be added to this directory are ones that will be
+used by the release script to update the CHANGES file automatically. The only
+time that it is necessary to add something to the CHANGES-staging directory is
+if you are either adding a new feature to Asterisk or adding new functionality
+to an existing feature. The file does not need to have a meaningful name, but
+it probably should. If there are multiple items that need documenting, each can
+be separated with a subject line, which should always start with "SUBJECT:",
+followed by the subject of the change. For example, if you are making a change
+to PJSIP, then you might add the file "res_pjsip_my_cool_feature" to this
+directory, with a short description of what it does. Here's an example:
+
+SUBJECT: res_pjsip
+
+Here's a pretty good description of my new feature that explains exactly what
+it does and how to use it.
+
+SUBJECT: core
+
+Here's another description of something else I added that is a big enough
+change to warrant another entry in the CHANGES file.
diff --git a/doc/CHANGES-staging/app_voicemail_aliasescontext b/doc/CHANGES-staging/app_voicemail_aliasescontext
new file mode 100644
index 0000000..e56dabd
--- /dev/null
+++ b/doc/CHANGES-staging/app_voicemail_aliasescontext
@@ -0,0 +1,5 @@
+Subject: app_voicemail
+
+You can now specify a special context with the "aliasescontext" parameter
+in voicemail.conf which will allow you to create aliases for physical
+mailboxes.
diff --git a/doc/CHANGES-staging/features_automon_automixmon b/doc/CHANGES-staging/features_automon_automixmon
new file mode 100644
index 0000000..b97c883
--- /dev/null
+++ b/doc/CHANGES-staging/features_automon_automixmon
@@ -0,0 +1,12 @@
+Subject: Features
+
+Before Asterisk 12, when using the automon or automixmon features defined
+in features.conf, a channel variable (TOUCH_MIXMONITOR_OUTPUT) was set on
+both channels, indicating the filename of the recording.
+
+When bridging was overhauled in Asterisk 12, the behavior was changed such
+that the variable was only set on the peer channel and not on the channel
+that initiated the automon or automixmon.
+
+The previous behavior has been restored so both channels receive the
+channel variable when one of these features is invoked.
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
new file mode 100644
index 0000000..e27a0c0
--- /dev/null
+++ b/doc/CHANGES-staging/res_pjsip_send_contact_status_on_update_registration
@@ -0,0 +1,4 @@
+Subject: res_pjsip
+
+Added "send_contact_status_on_update_registration" global configuration option
+to enable sending AMI ContactStatus event when a device refreshes its registration.
diff --git a/doc/UPGRADE-staging/README b/doc/UPGRADE-staging/README
new file mode 100644
index 0000000..95ec1ff
--- /dev/null
+++ b/doc/UPGRADE-staging/README
@@ -0,0 +1,22 @@
+DO NOT REMOVE THIS FILE!
+
+The only files that should be added to this directory are ones that will be
+used by the release script to update the UPGRADE.txt file automatically. The
+only time that it is necessary to add something to the UPGRADE-staging directory
+is if you are making a breaking change to an existing feature in Asterisk. The
+file does not need to have a meaningful name, but it probably should. If there
+are multiple items that need documenting, each can be separated with a subject
+line, which should always start with "SUBJECT:", followed by the subject of the
+change. For example, if you are making a change to PJSIP, then you might add the
+file "res_pjsip_breaking_change" to this directory, with a short description of
+what it does. Here's an example:
+
+SUBJECT: res_pjsip
+
+Here's a pretty good description of what I changed that explains exactly what
+it does and why it breaks things (and why they needed to be broken).
+
+SUBJECT: core
+
+Here's another description of something else I added that is a big enough
+change to warrant another entry in the UPDATE.txt file.

-- 
To view, visit https://gerrit.asterisk.org/10943
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 13
Gerrit-MessageType: newchange
Gerrit-Change-Id: I19cf4b569321c88155a65e9b0b80f6d58075dd47
Gerrit-Change-Number: 10943
Gerrit-PatchSet: 1
Gerrit-Owner: Benjamin Keith Ford <bford at digium.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20190201/ae63da98/attachment-0001.html>
