Mark res_ais as experimental, as the binary event format is subject to change.

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

diff --git a/configs/ais.conf.sample b/configs/ais.conf.sample
index 42991a6..f0bccc6 100644 (file)
--- a/configs/ais.conf.sample
+++ b/configs/ais.conf.sample
@@ -11,6 +11,15 @@
 ;
 
 ;
+;                            *** NOTE ***
+; This document includes some information about using the res_ais module for
+; distributed events.  However, it is important to note that res_ais is still
+; considered experimental, as the module exposes the binary format of events
+; over the network between servers.  This format is still subject to change
+; between 1.6.X releases.
+;                            ************
+
+;
 ; [general]
 ; The general section is reserved but not currently used.
 ;

diff --git a/doc/distributed_devstate.txt b/doc/distributed_devstate.txt
index 0339093..954fdbc 100644 (file)
--- a/doc/distributed_devstate.txt
+++ b/doc/distributed_devstate.txt
@@ -8,6 +8,16 @@
 ===============================================================================
 
 -------------------------------------------------------------------------------
+--- IMPORTANT NOTE
+-------------------------------------------------------------------------------
+
+This document includes some information about using the res_ais module for
+distributed events.  However, it is important to note that res_ais is still
+considered experimental, as the module exposes the binary format of events
+over the network between servers.  This format is still subject to change
+between 1.6.X releases.
+
+-------------------------------------------------------------------------------
 --- INTRODUCTION
 -------------------------------------------------------------------------------
 

diff --git a/res/res_ais.c b/res/res_ais.c
index 865f424..adb3290 100644 (file)
--- a/res/res_ais.c
+++ b/res/res_ais.c
@@ -26,6 +26,10 @@
  *
  * This file contains the common code between the uses of the different AIS
  * services.
+ *
+ * \note This module is still considered experimental, as it exposes the
+ * internal binary format of events between Asterisk servers over a network.
+ * However, this format is still subject to change between 1.6.X releases.
  */
 
 /*** MODULEINFO