[svn-commits] pabelanger: branch pabelanger/configs r898 - /asterisk/team/pabelanger/configs/

[SVN commits to the Digium repositories]

Author: pabelanger
Date: Sun Nov 21 11:38:13 2010
New Revision: 898

URL: http://svnview.digium.com/svn/testsuite?view=rev&rev=898
Log:
Update documentation

Modified:
    asterisk/team/pabelanger/configs/README.txt

Modified: asterisk/team/pabelanger/configs/README.txt
URL: http://svnview.digium.com/svn/testsuite/asterisk/team/pabelanger/configs/README.txt?view=diff&rev=898&r1=897&r2=898
==============================================================================
--- asterisk/team/pabelanger/configs/README.txt (original)
+++ asterisk/team/pabelanger/configs/README.txt Sun Nov 21 11:38:13 2010
@@ -187,12 +187,26 @@
              -> run-test
              -> test-config.yaml
              ...
-
-        Finally, to have a test included in the test suite, it must be added to
-the "tests.yaml" file that lives in the tests directory.  This configuration
-file determines the order that the tests are considered for execution by the top
+        /configs
+          -> asterisk.options.conf.inc
+          -> logger.conf
+          -> logger.general.conf.inc
+          ...
+
+        To have a test included in the test suite, it must be added to the
+"tests.yaml" file that lives in the tests directory.  This configuration file
+determines the order that the tests are considered for execution by the top
 level test suite application.
 
+        The purpose of the 'configs' directory is to define global settings for
+Asterisk.  Tests will inherit these settings every time the testsuite creates
+sandbox instances of Asterisk.  Additionally, tests have the ability to override
+these setting, however it is NOT recommended they do so.  If you wanted to add a
+setting to logger.conf [logfiles], you could create a 'logger.logfiles.conf.inc'
+file for your test and the global Asterisk logger.conf will automatically
+include it. The filename convention is <asterisk module>.<category>.conf.inc.
+Again, settings in 'asterisk.options.conf.inc' would be included in
+asterisk.conf [options] category.
 
 b) Preconditions
 
@@ -200,7 +214,6 @@
 system has a fresh install of Asterisk with files installed into their default
 locations.  This includes a fresh set of sample configuration files in the
 /etc/asterisk directory.
-
 
 c) Test Execution