Document DATADIR and SRCDIR in the manpage

2 files changed, 22 insertions, 0 deletions

diff --git a/NEWS b/NEWS
index 15b29a1..797291e 100644
--- a/NEWS
+++ b/NEWS
@@ -19,6 +19,9 @@ Version 0.10, released UNRELEASED
 
 * Yarn now reports scenarios skipped because of ASSUMING failing.
 
+* Yarn manual page now documents DATADIR and SRCDIR environment
+  variables.
+
 Bug fixes:
 
 * Yarn now complains if a scenario has no THEN steps. Suggested by
diff --git a/yarn.1.in b/yarn.1.in
index 85d2d8e..f1708d9 100644
--- a/yarn.1.in
+++ b/yarn.1.in
@@ -109,7 +109,26 @@ by a programmer,
 but given a well-designed set of steps,
 with enough flexibility in their implementation,
 that quite a good test suite can be written.
+.PP
+The shell commands in an IMPLEMENTS section are run in the directory
+in which the user ran
+.BR yarn .
+The environment variable
+.B SRCDIR
+is set to the fully qualified path to that directory.
 .SH OPTIONS
+.SH ENVIRONMENT
+.TP
+.B DATADIR
+Fully qualified pathname to a temporary directory,
+in which the tests can use files.
+The temporary directory is removed at the end of the test execution,
+unless the user specifies otherwise with \-\-snapshot.
+.TP
+.B SRCDIR
+Fully qualitifed pathname to the directory in which the user ran
+.BR yarn .
+This is useful when the tests want to change the directory.
 .SH EXAMPLE
 To run
 .B yarn