From ae9b42a911f30d1666e5f3cc82ce28eed7afaebf Mon Sep 17 00:00:00 2001 From: Snaipe Date: Wed, 11 Feb 2015 14:22:49 +0100 Subject: [PATCH] Added environment variable documentation --- doc/env.rst | 15 +++++++++++++++ doc/index.rst | 1 + 2 files changed, 16 insertions(+) create mode 100644 doc/env.rst diff --git a/doc/env.rst b/doc/env.rst new file mode 100644 index 0000000..091f489 --- /dev/null +++ b/doc/env.rst @@ -0,0 +1,15 @@ +Environment and CLI +=================== + +Tests built with Criterion support environment variables to alter +their runtime behaviour. + +Environment Variables +--------------------- + +* `CRITERION_ALWAYS_SUCCEED`: when set to `1`, the exit status of the test + process will be 0, regardless if the tests failed or not. +* `CRITERION_NO_EARLY_EXIT`: when set to `1`, the test workers shall not + call `_exit` when done and will properly return from the main and + clean up their process space. This is useful when tracking memory leaks with + `valgrind --tool=memcheck`. diff --git a/doc/index.rst b/doc/index.rst index 7aba9ad..b138762 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -8,3 +8,4 @@ Criterion setup starter hooks + env