summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2013-07-31 18:41:45 +0100
committerLars Wirzenius <liw@liw.fi>2013-07-31 18:41:45 +0100
commit02fe4bfce7b93c54e7e0e1a68a822dcd7764b30f (patch)
treee27f4fea6c15482c50d8b132c335f79ece61149d
parent8e8b0139119f102b08283c528ddbae70728bc188 (diff)
downloadcmdtest-02fe4bfce7b93c54e7e0e1a68a822dcd7764b30f.tar.gz
Add to README mention of environment cleanup
-rw-r--r--README.yarn5
1 files changed, 5 insertions, 0 deletions
diff --git a/README.yarn b/README.yarn
index 7006a66..16f7522 100644
--- a/README.yarn
+++ b/README.yarn
@@ -140,6 +140,11 @@ The following keywords are defined.
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