summaryrefslogtreecommitdiff
path: root/doc/CODING-GUIDELINES
diff options
context:
space:
mode:
authorOlle Johansson <oej@edvina.net>2006-04-04 07:59:02 +0000
committerOlle Johansson <oej@edvina.net>2006-04-04 07:59:02 +0000
commita0b9439beee6457dd2177072c0dc0959e18345cd (patch)
tree92bad1e817bd0cc134548572cb0f734c8c6316da /doc/CODING-GUIDELINES
parentf11fb652624802eaeb8f8539733d326b246c6aab (diff)
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
Diffstat (limited to 'doc/CODING-GUIDELINES')
-rw-r--r--doc/CODING-GUIDELINES13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/CODING-GUIDELINES b/doc/CODING-GUIDELINES
index c8afc704e..a19fd0ad0 100644
--- 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!