From d7da92821e8136c5d20d7dae17740282ce27c52d Mon Sep 17 00:00:00 2001 From: Siri Hansen Date: Wed, 9 Mar 2016 13:07:49 +0100 Subject: Document that any ssh option is allowed in ct_netconfc The code was changed by OTP-13338, commit bf309240cb531df880989702ae901316e8b5e97d. --- lib/common_test/doc/src/ct_netconfc.xml | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'lib/common_test') diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml index 8139d8afdb..d181afbb76 100644 --- a/lib/common_test/doc/src/ct_netconfc.xml +++ b/lib/common_test/doc/src/ct_netconfc.xml @@ -201,10 +201,8 @@ information, see module ct.

- host() = hostname() | ip_address() - -

For hostname() and ip_address(), see module - kernel:inet

 + host() = inet:hostname() | inet:ip_address() + key_or_name() = server_id() | target_name() @@ -220,10 +218,13 @@ notification_content() = [event_time() | simple_xml()] - option() = {ssh, host()} | {port, port_number()} | {user, string()} | {password, string()} | {user_dir, string()} | {timeout, timeout()} + option() = {ssh, host()} | {port, inet:port_number()} | {timeout, timeout()} | ssh_connect_option() -

For port_number(), see module - kernel:inet

 +

For ssh_connect_option(), see + ssh:connect/3,4. Common + SSH connect options are user, password + and user_dir, but any option that is verified as valid + by application SSH is allowed.

 options() = [option()] @@ -887,7 +888,7 @@ SessionId, infinity).

ct_netconfc:open/2 instead.

-

The opaque handler() reference returned from this +

The opaque handle() reference returned from this function is required as client identifier when calling any other function in this module.

-- cgit v1.2.3 From 880280b22f30a5ba67dcbd93bf85e14c04acc25b Mon Sep 17 00:00:00 2001 From: Siri Hansen Date: Thu, 10 Mar 2016 12:00:48 +0100 Subject: Fix link errors in common_test documentation These were introduced when converting from edoc to xml files for the common_test documentation. --- lib/common_test/doc/src/ct.xml | 10 ++++----- lib/common_test/doc/src/ct_hooks_chapter.xml | 16 +++++++-------- lib/common_test/doc/src/ct_netconfc.xml | 2 +- lib/common_test/doc/src/ct_rpc.xml | 4 ++-- lib/common_test/doc/src/ct_snmp.xml | 7 +++---- lib/common_test/doc/src/ct_ssh.xml | 4 ++-- lib/common_test/doc/src/dependencies_chapter.xml | 10 ++++----- lib/common_test/doc/src/test_structure_chapter.xml | 4 ++-- lib/common_test/doc/src/write_test_chapter.xml | 24 +++++++++++----------- 9 files changed, 40 insertions(+), 41 deletions(-) (limited to 'lib/common_test') diff --git a/lib/common_test/doc/src/ct.xml b/lib/common_test/doc/src/ct.xml index ed3d76061a..d215d68f30 100644 --- a/lib/common_test/doc/src/ct.xml +++ b/lib/common_test/doc/src/ct.xml @@ -57,9 +57,9 @@

data_dir - Data file directory

priv_dir - Scratch file directory

Whatever added by - init_per_suite/1 + init_per_suite/1 or - init_per_testcase/2 + init_per_testcase/2 in the test suite.

 @@ -359,7 +359,7 @@ Configuration Files in the User's Guide.

For details on DES3 encryption/decryption, see application - Crypto.

+ Crypto.

@@ -385,7 +385,7 @@ Configuration Files in the User's Guide.

For details on DES3 encryption/decryption, see application - Crypto.

+ Crypto.

@@ -1357,7 +1357,7 @@

Returns any data specified with tag userdata in the list of tuples returned from - suite/0.

+ suite/0.

 diff --git a/lib/common_test/doc/src/ct_hooks_chapter.xml b/lib/common_test/doc/src/ct_hooks_chapter.xml index 8f48756ada..95943ced94 100644 --- a/lib/common_test/doc/src/ct_hooks_chapter.xml +++ b/lib/common_test/doc/src/ct_hooks_chapter.xml @@ -237,10 +237,10 @@ init_per_suite - init_per_group - init_per_testcase - end_per_group - end_per_suite + init_per_group + init_per_testcase + end_per_group + end_per_suite

@@ -280,10 +280,10 @@

In a CTH, behavior can be hooked in after the following functions:

init_per_suite - init_per_group - end_per_testcase - end_per_group - end_per_suite + init_per_group + end_per_testcase + end_per_group + end_per_suite

diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml index d181afbb76..77366da891 100644 --- a/lib/common_test/doc/src/ct_netconfc.xml +++ b/lib/common_test/doc/src/ct_netconfc.xml @@ -239,7 +239,7 @@ simple_xml() = {xml_tag(), xml_attributes(), xml_content()} | {xml_tag(), xml_content()} | xml_tag()

This type is further described in application - xmerl.

 + xmerl.

stream_data() = {description, string()} | {replaySupport, string()} | {replayLogCreationTime, string()} | {replayLogAgedTime, string()} diff --git a/lib/common_test/doc/src/ct_rpc.xml b/lib/common_test/doc/src/ct_rpc.xml index 132d04545d..0169727581 100644 --- a/lib/common_test/doc/src/ct_rpc.xml +++ b/lib/common_test/doc/src/ct_rpc.xml @@ -73,7 +73,7 @@

Same as - ct_rpc:app_node/2, + ct_rpc:app_node/2, except that argument FailOnBadRPC determines if the search for a candidate node is to stop if badrpc is received at some point.

@@ -94,7 +94,7 @@

Same as - ct_rpc:app_node/2, + ct_rpc:app_node/2, except that argument FailOnBadRPC determines if the search for a candidate node is to stop if badrpc is received at some point.

diff --git a/lib/common_test/doc/src/ct_snmp.xml b/lib/common_test/doc/src/ct_snmp.xml index 60f1d600e0..d001fb24ec 100644 --- a/lib/common_test/doc/src/ct_snmp.xml +++ b/lib/common_test/doc/src/ct_snmp.xml @@ -148,7 +148,7 @@

SNMP traps, inform, and report messages are handled by the user callback module. For details, see the - SNMP application.

+ SNMP application.

It is recommended to use the .hrl files created by the Erlang/OTP MIB compiler to define the Object Identifiers (OIDs). @@ -160,8 +160,7 @@

Furthermore, values can be set for SNMP application configuration parameters, config, server, net_if, and so on (for - a list of valid parameters and types, see the User's Guide for - the SNMP application). This is + a list of valid parameters and types, see the User's Guide for the SNMP application). This is done by defining a configuration data variable on the following form:

@@ -236,7 +235,7 @@
        
     
     
These data types are described in the documentation for
-      the SNMP application.

+      the SNMP application.

   
 
   
diff --git a/lib/common_test/doc/src/ct_ssh.xml b/lib/common_test/doc/src/ct_ssh.xml
index 897fd509d3..92b1f60b8c 100644
--- a/lib/common_test/doc/src/ct_ssh.xml
+++ b/lib/common_test/doc/src/ct_ssh.xml
@@ -296,7 +296,7 @@
           the configuration data for KeyOrName. The extra options
           override any existing options with the same key in the
           configuration data. For details on valid SSH options, see
-          application SSH.

+          application SSH.

       
     
 
@@ -976,7 +976,7 @@ ChannelId, 0, Data, End, Timeout).

           receive the server response.

 
         
For details on argument End, see
-          ct_ssh:receive_response/4.

+          ct_ssh:receive_response/4.

       
     
 
diff --git a/lib/common_test/doc/src/dependencies_chapter.xml b/lib/common_test/doc/src/dependencies_chapter.xml
index d96a41473f..29c54e819a 100644
--- a/lib/common_test/doc/src/dependencies_chapter.xml
+++ b/lib/common_test/doc/src/dependencies_chapter.xml
@@ -87,8 +87,8 @@
       
To avoid this, we can consider starting and stopping the server for every test.
       We can thus implement the start and stop action as common functions to be 
       called from 
-      init_per_testcase and 
-      end_per_testcase. 
+      init_per_testcase and 
+      end_per_testcase. 
       (Remember to test the start and stop functionality separately.) 
       The configuration can also be implemented as a common function, maybe grouped 
       with the start function. Finally, the testing of connecting and disconnecting a 
@@ -194,9 +194,9 @@
 
       
To pass data from one test suite to another, the same mechanism is used. The data
 	is to be saved by finction
-	end_per_suite 
+	end_per_suite 
 	and read by function
-	init_per_suite
+	init_per_suite
 	in the suite that follows. When passing data between suites, Saver carries the 
 	name of the test suite.

 
@@ -306,7 +306,7 @@
         any property, that is, they are not required to also be sequences. If you want the 
 	status of the subgroup to affect the sequence on the level above, return 
 	{return_group_result,Status} from 
-	end_per_group/2, 
+	end_per_group/2, 
 	as described in section
 	Repeated Groups
 	in Writing Test Suites.
diff --git a/lib/common_test/doc/src/test_structure_chapter.xml b/lib/common_test/doc/src/test_structure_chapter.xml
index a9e2c0bf9f..8076244928 100644
--- a/lib/common_test/doc/src/test_structure_chapter.xml
+++ b/lib/common_test/doc/src/test_structure_chapter.xml
@@ -60,8 +60,8 @@
       
 
       Returning {skip,Reason} from function
-      init_per_testcase/2 or 
-      init_per_suite/1.
+      init_per_testcase/2 or 
+      init_per_suite/1.
 
       Returning {skip,Reason} from the execution clause
       of the test case. The execution clause is called, so the author 
diff --git a/lib/common_test/doc/src/write_test_chapter.xml b/lib/common_test/doc/src/write_test_chapter.xml
index 3e30974c9f..8c1d104949 100644
--- a/lib/common_test/doc/src/write_test_chapter.xml
+++ b/lib/common_test/doc/src/write_test_chapter.xml
@@ -67,7 +67,7 @@
     

 
     
Each test suite module must export function 
-    all/0,
+    all/0,
       which returns the list of all test case groups and test cases 
       to be executed in that module. 
     

@@ -83,8 +83,8 @@
     Init and End per Suite
 
     
Each test suite module can contain the optional configuration functions
-    init_per_suite/1
-    and end_per_suite/1. 
+    init_per_suite/1
+    and end_per_suite/1. 
     If the init function is defined, so must the end function be.
     
    
 
@@ -138,8 +138,8 @@
     Init and End per Test Case
 
     
Each test suite module can contain the optional configuration functions
-    init_per_testcase/2
-    and end_per_testcase/2. 
+    init_per_testcase/2
+    and end_per_testcase/2. 
     If the init function is defined, so must the end function be.

 
     
If init_per_testcase exists, it is called before each
@@ -378,7 +378,7 @@
     
       
If timetrap or require, or both, is not set specifically for
 	a particular test case, default values specified by function
-	suite/0 
+	suite/0 
 	are used.
       

 
@@ -404,7 +404,7 @@
     
     Test Suite Information Function
 
-      
Function suite/0 
+      
Function suite/0 
         can, for example, be used in a test suite module to set a default 
 	timetrap value and to require external configuration data. 
 	If a test case, or a group information function also specifies any of the information tags, it
@@ -445,7 +445,7 @@
     
A test case group is a set of test cases sharing configuration 
     functions and execution properties. Test case groups are defined by
     function 
-    groups/0
+    groups/0
     according to the following syntax:

     
  groups() -> GroupDefs
@@ -559,12 +559,12 @@
       execution is immediately stopped and the remaining cases are skipped.

 
     
Before execution of a group begins, the configuration function
-    init_per_group(GroupName, Config) 
+    init_per_group(GroupName, Config) 
     is called. The list of tuples returned from this function is passed to the 
     test cases in the usual manner by argument Config. 
     init_per_group/2 is meant to be used for initializations common 
     for the test cases in the group. After execution of the group is finished, function
-    end_per_group(GroupName, Config) 
+    end_per_group(GroupName, Config) 
     is called. This function is meant to be used for cleaning up after 
     init_per_group/2.

 
@@ -652,7 +652,7 @@
     Parallel Test Cases and I/O
     
A parallel test case has a private I/O server as its group leader. 
       (For a description of the group leader concept, see
-      ERTS). 
+      ERTS). 
       The central I/O server process, which handles the output from 
       regular test cases and configuration functions, does not respond to I/O messages
       during execution of parallel groups. This is important to understand
@@ -1125,7 +1125,7 @@
 	      environment as possible, so that subsequent test cases
 	      do not crash because of their execution order. 
 	      The function 
-	      end_per_testcase 
+	      end_per_testcase 
 	      is suitable for this.
 	    

 	
-- 
cgit v1.2.3