Clarify syntax of new manager events that reports a status.

We do not longer approve "ThisEventOn" and "ThisEventOff" named events,
they need to be named "ThisEvent" with a status header showing the
current status.
(Approved by Mark)
Old events won't be changed to keep backwards compatibility,
until we have a revision plan for the AMI.

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@17199 65c4cc65-6c06-0410-ace0-fbb531ad65f3

diff --git a/doc/CODING-GUIDELINES b/doc/CODING-GUIDELINES
index c8afc704e7c447a3f0b85a155798607bd171ba22..a19fd0ad070f3583c8c3193a13d0e9f7000cfe5a 100644 (file)
--- a/doc/CODING-GUIDELINES
+++ b/doc/CODING-GUIDELINES
@@ -522,6 +522,19 @@ int len = 0;
 if (name && (len = strlen(name) + strlen(prefix) + strlen(postfix) + 3) && (newname = alloca(len)))
        snprintf(newname, len, "%s/%s/%s", prefix, name, postfix);
 
+* Creating new manager events?
+------------------------------
+If you create new AMI events, please read manager.txt. Do not re-use
+existing headers for new purposes, but please re-use existing headers
+for the same type of data.
+
+Manager events that signal a status are required to have one
+event name, with a status header that shows the status.
+The old style, with one event named "ThisEventOn" and another named
+"ThisEventOff", is no longer approved.
+
+Check manager.txt for more information on manager and existing
+headers. Please update this file if you add new headers.
 
 -----------------------------------------------
 Welcome to the Asterisk development community!

diff --git a/doc/manager.txt b/doc/manager.txt
index 065d70a2146ff680409f18f213420c0eb212e515..cee0c470a9ad1fd3486d1a2b8c69fc5729a82d37 100644 (file)
--- a/doc/manager.txt
+++ b/doc/manager.txt
@@ -296,3 +296,4 @@ Some standard AMI headers:
 
  ** Please try to re-use existing headers to simplify manager message parsing in clients.
 
+Read the CODING-GUIDELINES if you develop new manager commands or events.