summaryrefslogtreecommitdiff
path: root/contrib/cvs/TESTS
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/cvs/TESTS')
-rw-r--r--contrib/cvs/TESTS11
1 files changed, 9 insertions, 2 deletions
diff --git a/contrib/cvs/TESTS b/contrib/cvs/TESTS
index fe01101eca20..dada9e37abdd 100644
--- a/contrib/cvs/TESTS
+++ b/contrib/cvs/TESTS
@@ -206,6 +206,10 @@ miss, but here are a few important ones. I'm leaving off long explanations
after the first few since it probably gives you the idea and the data is in
sanity.sh.
+Note that the boolean variables contain shell commands which return true or
+false when executed and are intended to be used like,
+"if $remote; then ... ; else ... ; fi"
+
* $testdir = the directory this test is taking place in
(CVSROOT=$testdir/cvsroot or CVSROOT=:fork:$testdir/cvsroot)
@@ -216,8 +220,11 @@ sanity.sh.
* $username = regexp to match a username
* $hostname = regexp to match a hostname
* $PROG = regexp to match progname in CVS error messages
- * $remote = 'yes' or 'no', depending on whether the script is running with
- a remote CVSROOT
+ * $remote = ':' (true) or 'false', depending on whether the script is
+ running with a remote CVSROOT
+ * $keep = ':' (true) or 'false'. When set, the first test run will
+ leave any files and directories it created in $testdir and
+ exit when complete.
And, of course, some characters like '.' in regexps need to be '\' escaped when
you mean them literally. Some characters may be interpreted by the shell,