[asterisk-commits] trunk r17199 - in /trunk/doc: CODING-GUIDELINES manager.txt

[asterisk-commits at lists.digium.com]

Author: oej
Date: Tue Apr  4 02:59:02 2006
New Revision: 17199

URL: http://svn.digium.com/view/asterisk?rev=17199&view=rev
Log:
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.

Modified:
    trunk/doc/CODING-GUIDELINES
    trunk/doc/manager.txt

Modified: trunk/doc/CODING-GUIDELINES
URL: http://svn.digium.com/view/asterisk/trunk/doc/CODING-GUIDELINES?rev=17199&r1=17198&r2=17199&view=diff
==============================================================================
--- trunk/doc/CODING-GUIDELINES (original)
+++ trunk/doc/CODING-GUIDELINES Tue Apr  4 02:59:02 2006
@@ -522,6 +522,19 @@
 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!

Modified: trunk/doc/manager.txt
URL: http://svn.digium.com/view/asterisk/trunk/doc/manager.txt?rev=17199&r1=17198&r2=17199&view=diff
==============================================================================
--- trunk/doc/manager.txt (original)
+++ trunk/doc/manager.txt Tue Apr  4 02:59:02 2006
@@ -296,3 +296,4 @@
 
  ** 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.