diff options
Diffstat (limited to 'README.yarn')
-rw-r--r-- | README.yarn | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/README.yarn b/README.yarn index 76d57b5..16f7522 100644 --- a/README.yarn +++ b/README.yarn @@ -136,6 +136,15 @@ The following keywords are defined. The test runner creates a temporary directory, whose name is given to the shell code in the `DATADIR` environment variable. + The test runner sets the `SRCDIR` environment variable to the + path to the directory it was invoked from (by convention, the + root of the source tree of the project). + + The test runner removes all other environment variables, except + `TERM`, `USER`, `USERNAME`, `LOGNAME`, `HOME`, and `PATH`. It also + forces `SHELL` set to `/bin/sh`, and `LC_ALL` set to `C`, in order + to have as clean an environment as possible for tests to run in. + The shell commands get invoked with `/bin/sh -eu`, and need to be written accordingly. Be careful about commands that return a non-zero exit code. There will eventually be a library of shell |