document var_metric so no bugreports will come in when it's actually a configuration...

(issue #12151)
Reported and patched by: caio1982
1.4 patch by me

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

diff --git a/doc/realtime.txt b/doc/realtime.txt
index a6ce28f82ece5bcb2d4ad5307119c7c3fce19f96..cc90e5f71dec8272bf21be6f75a32a606d82d65d 100644 (file)
--- a/doc/realtime.txt
+++ b/doc/realtime.txt
@@ -41,6 +41,20 @@ modules that read configurations, there's no difference between a static
 file in the file system, like extensions.conf, and a configuration loaded
 from a database.
 
+You just have to always make sure the var_metric values are properly set and
+ordered as you expect in your database server if you're using the static mode
+with ARA (either sequentially or with the same var_metric value for everybody).
+
+If you have an option that depends on another one in a given configuration
+file (i.e, 'musiconhold' depending on 'agent' from agents.conf) but their
+var_metric are not sequential you'll probably get default values being assigned for
+those options instead of the desired ones. You can still use the same
+var_metric for all entries in your DB, just make sure the entries
+are recorded in an order that does not break the option dependency.
+
+That doesn't happen when you use a static file in the file system. Although
+this might be interpreted as a bug or limitation, it is not.
+
 * Realtime SIP friends
 ----------------------
 The SIP realtime objects are users and peers that are loaded in memory