From a71c6b976fa79fa3bcd0e61850a1a57071159b28 Mon Sep 17 00:00:00 2001
From: Lukas Larsson <lukas@erlang-solutions.com>
Date: Thu, 9 Aug 2012 18:00:13 +0200
Subject: Update user config to use nested tuple keys

ct:get_config and ct:require can now use nested tuples
to fetch data from user configuration. E.g.

ct:get_config({localhost,ip,v4}).

This introduces a backwards incompatability with how names
are associated with keys when using require/2. E.g.

ct:require(a_name,{localhost,ip}) will associate a_name with ip
instead of localhost.
---
 lib/common_test/doc/src/common_test_app.xml       | 6 +++---
 lib/common_test/doc/src/config_file_chapter.xml   | 2 +-
 lib/common_test/doc/src/event_handler_chapter.xml | 4 ++--
 lib/common_test/doc/src/write_test_chapter.xml    | 3 ++-
 4 files changed, 8 insertions(+), 7 deletions(-)

(limited to 'lib/common_test/doc/src')

diff --git a/lib/common_test/doc/src/common_test_app.xml b/lib/common_test/doc/src/common_test_app.xml
index 6babdb93af..addeed002a 100644
--- a/lib/common_test/doc/src/common_test_app.xml
+++ b/lib/common_test/doc/src/common_test_app.xml
@@ -162,7 +162,7 @@
 	<v> Func = atom()</v>
 	<v> Args = list()</v>
 	<v> Fun = fun()</v>
-	<v> Required = Key | {Key,SubKeys}</v>
+	<v> Required = Key | {Key,SubKeys} | {Key,SubKey} | {Key,SubKey,SubKeys}</v>
 	<v> Key = atom()</v>
 	<v> SubKeys = SubKey | [SubKey]</v>
 	<v> SubKey = atom()</v>
@@ -289,7 +289,7 @@
 	<v> Func = atom()</v>
 	<v> Args = list()</v>
 	<v> Fun = fun()</v>
-	<v> Required = Key | {Key,SubKeys}</v>
+	<v> Required = Key | {Key,SubKeys} | {Key,Subkey} | {Key,Subkey,SubKeys}</v>
 	<v> Key = atom()</v>
 	<v> SubKeys = SubKey | [SubKey]</v>
 	<v> SubKey = atom()</v>
@@ -476,7 +476,7 @@
 	<v> Func = atom()</v>
 	<v> Args = list()</v>
 	<v> Fun = fun()</v>
-	<v> Required = Key | {Key,SubKeys}</v>
+	<v> Required = Key | {Key,SubKeys} | {Key,Subkey} | {Key,Subkey,SubKeys}</v>
 	<v> Key = atom()</v>
 	<v> SubKeys = SubKey | [SubKey]</v>
 	<v> SubKey = atom()</v>
diff --git a/lib/common_test/doc/src/config_file_chapter.xml b/lib/common_test/doc/src/config_file_chapter.xml
index 6a860bb58b..706d0d5f4e 100644
--- a/lib/common_test/doc/src/config_file_chapter.xml
+++ b/lib/common_test/doc/src/config_file_chapter.xml
@@ -295,7 +295,7 @@
 
       <pre>
         [{ftp_host, [{ftp, "targethost"}, {username, "tester"}, {password, "letmein"}]},
-        {lm_directory, "/test/loadmodules"}]</pre>
+         {lm_directory, "/test/loadmodules"}]</pre>
 
     </section>
 
diff --git a/lib/common_test/doc/src/event_handler_chapter.xml b/lib/common_test/doc/src/event_handler_chapter.xml
index a5886b9687..2f796b91ab 100644
--- a/lib/common_test/doc/src/event_handler_chapter.xml
+++ b/lib/common_test/doc/src/event_handler_chapter.xml
@@ -205,7 +205,7 @@
 	                   {error,{RunTimeError,StackTrace}} | 
                            {timetrap_timeout,integer()} | 
 			   {failed,{Suite,end_per_testcase,FailInfo}}</c>, reason for failure.</p>	
-        <p><c>RequireInfo = {not_available,atom()}</c>, why require has failed.</p>
+        <p><c>RequireInfo = {not_available,atom() | tuple()}</c>, why require has failed.</p>
         <p><c>FailInfo = {timetrap_timeout,integer()} | 
 	                 {RunTimeError,StackTrace} | 
 			 UserTerm</c>, 
@@ -233,7 +233,7 @@
 	      reason for auto skipping <c>Func</c>.</p>
         <p><c>FailReason = {Suite,ConfigFunc,FailInfo}} | 
 	                   {Suite,FailedCaseInSequence}</c>, reason for failure.</p>	
-        <p><c>RequireInfo = {not_available,atom()}</c>, why require has failed.</p>
+        <p><c>RequireInfo = {not_available,atom() | tuple()}</c>, why require has failed.</p>
         <p><c>ConfigFunc = init_per_suite | init_per_group</c></p>
         <p><c>FailInfo = {timetrap_timeout,integer()} | 
 	                 {RunTimeError,StackTrace} |
diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index 7b7e7af8ea..d545c9e432 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -338,7 +338,8 @@
 
 	  <pre>
 	    testcase2() -> 
-	        [{require, unix_telnet, {unix, [telnet, username, password]}},
+	        [{require, unix_telnet, unix},
+		 {require, {unix, [telnet, username, password]}},
 	         {default_config, unix, [{telnet, "my_telnet_host"},
 	                                 {username, "aladdin"},
 	                                 {password, "sesame"}]}}].</pre>
-- 
cgit v1.2.3