From 6bc33458b808d5f76010d428bdf609791d436fb2 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sun, 25 Dec 2011 18:33:42 +0000 Subject: remove manpage stuff from README, add legalese --- README | 64 ++++++++++++++++++++-------------------------------------------- 1 file changed, 20 insertions(+), 44 deletions(-) (limited to 'README') diff --git a/README b/README index c49eae6..300770b 100644 --- a/README +++ b/README @@ -6,48 +6,24 @@ Given some test scripts, their inputs, and expected outputs, it verifies that the command line produces the expected output. If not, it reports problems, and shows the differences. -Each test case consists of: - -* a script to run the test (`foo.script`) -* the file fed to standard input (`foo.stdin`) -* the expected output to the standard output (`foo.stdout`) -* the expected output to the standard error (`foo.stderr`) -* the expected exit code (`foo.exit`) -* a shell script to run before the test (`foo.setup`) -* a shell script to run after the test (`foo.teardown`) - -Usually, a single test is not enough. All tests are put into the -same directory, and they may share some setup and teardown code: - -* a shell script to run once, before all tests (`setup-once`) -* a shell script to run before each test (`setup`) -* a shell script to run after each test (`teardown`) -* a shell script to run after all tests (`teardown-once`) - -`cmdtest` is given the name of the directory with all the tests, -or several such directories, and it does the following: - -* execute `setup-once` -* for each test case (unique prefix `foo`): - - execute `setup` - - execute `foo.setup` - - execute the command, by running `foo.script`, - and redirecting standard input to come from `foo.stdin` - - capture standard output and error and exit codes - - execute `foo.teardown` - - execute `teardown` - - report result of test: does exit code match `foo.exit`, standard - output match `foo.stdout`, and standard error match `foo.stderr`? -* execute `teardown-once` - -Except for the `.script`, all of these files are optional. -If a setup/teardown script is missing, it is simply not executed. -If one of the standard input, output, or error files is missing, -it is treated as if it were empty. -If the exit code file is missing, it is treated as if it specified an exit -code of zero. - -The shell scripts may use the following environment variables: - -* `DATADIR`: a temporary directory where files may be created by the test +See the manual page for details on how to use the program. + + +Legalese +-------- + +Copyright 2011 Lars Wirzenius + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . -- cgit v1.2.1