From fc13629197e7c3698ff0739b51d8219069444dec Mon Sep 17 00:00:00 2001 From: Kenneth Lundin Date: Thu, 29 Aug 2013 11:56:20 +0200 Subject: Corrections so that the documentation confirms to the DTD --- lib/common_test/doc/src/config_file_chapter.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'lib/common_test/doc/src/config_file_chapter.xml') diff --git a/lib/common_test/doc/src/config_file_chapter.xml b/lib/common_test/doc/src/config_file_chapter.xml index d90adf8d7b..99e25faf27 100644 --- a/lib/common_test/doc/src/config_file_chapter.xml +++ b/lib/common_test/doc/src/config_file_chapter.xml @@ -80,7 +80,7 @@ test is skipped (unless a default value has been specified, see the test case info function chapter for details). There is also a function - ct:require/1/2 which can be called from a test case + ct:require/1/2 which can be called from a test case in order to check if a specific variable is available. The return value from this function must be checked explicitly and appropriate action be taken depending on the result (e.g. to skip the test case @@ -90,7 +90,7 @@ info-list should look like this: {require,CfgVarName} or {require,AliasName,CfgVarName}. The arguments AliasName and CfgVarName are the same as the - arguments to ct:require/1/2 which are described in the + arguments to ct:require/1/2 which are described in the reference manual for ct. AliasName becomes an alias for the configuration variable, and can be used as reference to the configuration data value. @@ -103,7 +103,7 @@ (or test case) and improve readability.

To read the value of a config variable, use the function - get_config/1/2/3 + get_config/1/2/3 which is also described in the reference manual for ct.

Example:

@@ -121,7 +121,7 @@
Using configuration variables defined in multiple files

If a configuration variable is defined in multiple files and you - want to access all possible values, you may use the ct:get_config/3 + want to access all possible values, you may use the ct:get_config/3 function and specify all in the options list. The values will then be returned in a list and the order of the elements corresponds to the order that the config files were specified at startup. Please see @@ -133,7 +133,7 @@

It is possible to encrypt configuration files containing sensitive data if these files must be stored in open and shared directories.

-

Call ct:encrypt_config_file/2/3 to have Common Test encrypt a +

Call ct:encrypt_config_file/2/3 to have Common Test encrypt a specified file using the DES3 function in the OTP crypto application. The encrypted file can then be used as a regular configuration file, in combination with other encrypted files or normal text files. The key @@ -142,7 +142,7 @@ decrypt_file flag/option, or a key file in a predefined location.

Common Test also provides decryption functions, - ct:decrypt_config_file/2/3, for recreating the original text + ct:decrypt_config_file/2/3, for recreating the original text files.

Please see the ct reference manual for @@ -152,8 +152,8 @@

Opening connections by using configuration data

There are two different methods for opening a connection - by means of the support functions in e.g. ct_ssh, ct_ftp, - and ct_telnet:

+ by means of the support functions in e.g. ct_ssh, ct_ftp, + and ct_telnet:

Using a configuration target name (an alias) as reference. Using the configuration variable as reference. -- cgit v1.2.3