summaryrefslogtreecommitdiff
path: root/test/common/README.md
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2019-04-26 15:14:47 -0400
committercjihrig <cjihrig@gmail.com>2019-04-29 08:48:28 -0400
commite30b119194266c9dca83ff84c118c48b749b87c7 (patch)
tree43c8b7a45b121e9cc4b3142692ef78e573d40969 /test/common/README.md
parent8b04d5c3ba9f6c2c1de8056dc25659278b7ad8c4 (diff)
downloadandroid-node-v8-e30b119194266c9dca83ff84c118c48b749b87c7.tar.gz
android-node-v8-e30b119194266c9dca83ff84c118c48b749b87c7.tar.bz2
android-node-v8-e30b119194266c9dca83ff84c118c48b749b87c7.zip
test: document NODE_TEST_KNOWN_GLOBALS
PR-URL: https://github.com/nodejs/node/pull/27434 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'test/common/README.md')
-rw-r--r--test/common/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/test/common/README.md b/test/common/README.md
index 0542c38bbc..0c8455dd28 100644
--- a/test/common/README.md
+++ b/test/common/README.md
@@ -9,6 +9,7 @@ This directory contains modules used to test the Node.js implementation.
* [Countdown module](#countdown-module)
* [DNS module](#dns-module)
* [Duplex pair helper](#duplex-pair-helper)
+* [Environment variables](#environment-variables)
* [Fixtures module](#fixtures-module)
* [Heap dump checker module](#heap-dump-checker-module)
* [HTTP2 module](#http2-module)
@@ -495,6 +496,17 @@ which returns an object `{ clientSide, serverSide }` where each side is a
There is no difference between client or server side beyond their names.
+## Environment variables
+
+The behavior of the Node.js test suite can be altered using the following
+environment variables.
+
+### NODE_TEST_KNOWN_GLOBALS
+
+A comma-separated list of variables names that are appended to the global
+variable whitelist. Alternatively, if `NODE_TEST_KNOWN_GLOBALS` is set to `'0'`,
+global leak detection is disabled.
+
## Fixtures Module
The `common/fixtures` module provides convenience methods for working with