summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorIgor Murzov <e-mail@date.by>2011-06-04 19:00:18 +0400
committerIgor Murzov <e-mail@date.by>2011-06-05 22:06:27 +0400
commit4f7e60a4253c46e316b9dac900249cd205f436fd (patch)
tree76d34af6f4423af33240d42e67bf5bb58c02695c /doc
parent59cee8c139aacb43e9f1bfa8258b551ed7de8c83 (diff)
downloadbash-completion-4f7e60a4253c46e316b9dac900249cd205f436fd.tar.gz
docs: Improve tester's manual
Diffstat (limited to 'doc')
-rw-r--r--doc/testing.txt18
1 files changed, 15 insertions, 3 deletions
diff --git a/doc/testing.txt b/doc/testing.txt
index 62b007b8..c4b7cf18 100644
--- a/doc/testing.txt
+++ b/doc/testing.txt
@@ -116,7 +116,7 @@ command has two stages which are now reflected in the two files:
Running the tests
-----------------
-The tests are run by calling `runtest` in the test directory:
+The tests are run by calling `runtest` command in the test directory:
-----------------------
runtest --outdir log --tool completion
runtest --outdir log --tool install
@@ -129,6 +129,12 @@ directory:
./runInstall
./runUnit
-----------------------
+To run a particular test, specify file name of your test as an argument to
+`runCompletion` script:
+-----------------------
+./runCompletion ssh.exp
+-----------------------
+That will run `test/completion/ssh.exp`.
Running tests via cron
@@ -214,7 +220,13 @@ Maintenance
Adding a completion test
~~~~~~~~~~~~~~~~~~~~~~~~
-You can run `cd test && ./generate` to add a test.
+You can run `cd test && ./generate cmd` to add a test for the `cmd` command.
+This will add two files with a very basic tests:
+----------------------------------
+test/completion/cmd.exp
+test/lib/completions/cmd.exp
+----------------------------------
+Place any additional tests into `test/lib/completions/cmd.exp`.
Fixing a completion test
@@ -451,7 +463,7 @@ Within test scripts the following library functions can be used:
The test environment needs to be put to fixed states when testing. For
instance the bash prompt (PS1) is set to the current test directory, followed
-by an ampersand (@). The default settings for `bash` reside in `config/bashrc`
+by an at sign (@). The default settings for `bash` reside in `config/bashrc`
and `config/inputrc`.
For each tool (completion, install, unit) a slightly different context is in