diff options
author | Lukas Larsson <[email protected]> | 2010-11-12 11:30:08 +0100 |
---|---|---|
committer | Lukas Larsson <[email protected]> | 2010-11-29 11:59:34 +0100 |
commit | 6693ec7fd21b3325495f1a3dd4139e39f056f790 (patch) | |
tree | ffe286466137fdb12cd9658928ce7294a4241684 /lib/common_test/doc/src/install_chapter.xml | |
parent | 451991730f405db085cc69fafd14b07ca3879458 (diff) | |
download | otp-6693ec7fd21b3325495f1a3dd4139e39f056f790.tar.gz otp-6693ec7fd21b3325495f1a3dd4139e39f056f790.tar.bz2 otp-6693ec7fd21b3325495f1a3dd4139e39f056f790.zip |
Update documentation after rename of run_test to ct_run
Diffstat (limited to 'lib/common_test/doc/src/install_chapter.xml')
-rw-r--r-- | lib/common_test/doc/src/install_chapter.xml | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/lib/common_test/doc/src/install_chapter.xml b/lib/common_test/doc/src/install_chapter.xml index 828588a673..89c497962d 100644 --- a/lib/common_test/doc/src/install_chapter.xml +++ b/lib/common_test/doc/src/install_chapter.xml @@ -34,8 +34,8 @@ <title>General information</title> <p>The two main interfaces for running tests with Common Test - are an executable program named run_test and an - erlang module named <c>ct</c>. The run_test program + are an executable program named ct_run and an + erlang module named <c>ct</c>. The ct_run program is compiled for the underlying operating system (e.g. Unix/Linux or Windows) during the build of the Erlang/OTP system, and is installed automatically with other executable programs in @@ -43,22 +43,22 @@ The <c>ct</c> interface functions can be called from the Erlang shell, or from any Erlang function, on any supported platform.</p> - <p>A legacy Bourne shell script - also named run_test - exists, + <p>A legacy Bourne shell script - named run_test - exists, which may be manually generated and installed. This script may be used - instead of the run_test program mentioned above, e.g. if the user + instead of the ct_run program mentioned above, e.g. if the user wishes to modify or customize the Common Test start flags in a simpler - way than making changes to the run_test C program.</p> + way than making changes to the ct_run C program.</p> <p>The Common Test application is installed with the Erlang/OTP system and no additional installation step is required to start using - Common Test by means of the run_test executable program, and/or the interface + Common Test by means of the ct_run executable program, and/or the interface functions in the <c>ct</c> module. If you wish to use the legacy Bourne - shell script version of run_test, however, this script needs to be + shell script version run_test, however, this script needs to be generated first, according to the instructions below.</p> <p><note>Before reading on, please note that since Common Test version 1.5, the run_test shell script is no longer required for starting - tests with Common Test from the OS command line. The run_test + tests with Common Test from the OS command line. The ct_run program (descibed above) is the new recommended command line interface for Common Test. The shell script exists mainly for legacy reasons and may not be updated in future releases of Common Test. It may even be removed. |