summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSamuel D. Leslie <sdl@nexiom.net>2019-01-24 09:45:02 +1100
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2019-01-26 03:12:50 +0200
commit303585eb293e1d6aa2c13d2cf47fa7285732237f (patch)
tree195e7dbb6ee61726b36a76fbf441f3a6125e48a2 /doc
parent71b00f0b5bbaf1b3bc5bb5e3523e54ebb52a83af (diff)
downloadandroid-node-v8-303585eb293e1d6aa2c13d2cf47fa7285732237f.tar.gz
android-node-v8-303585eb293e1d6aa2c13d2cf47fa7285732237f.tar.bz2
android-node-v8-303585eb293e1d6aa2c13d2cf47fa7285732237f.zip
repl: improve doc for disabling REPL history on Windows
Environment variables with empty values are not permitted on Windows. As such, to disable persistent REPL history one or more spaces should be used. Node will trim whitespace from the variable, resulting in a blank variable at runtime and the desired behaviour. PR-URL: https://github.com/nodejs/node/pull/25672 Fixes: https://github.com/nodejs/node/issues/25661 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/repl.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/api/repl.md b/doc/api/repl.md
index 09fe9ebcbe..60adbf641d 100644
--- a/doc/api/repl.md
+++ b/doc/api/repl.md
@@ -540,8 +540,10 @@ environment variables:
- `NODE_REPL_HISTORY` - When a valid path is given, persistent REPL history
will be saved to the specified file rather than `.node_repl_history` in the
- user's home directory. Setting this value to `''` will disable persistent
- REPL history. Whitespace will be trimmed from the value.
+ user's home directory. Setting this value to `''` (an empty string) will
+ disable persistent REPL history. Whitespace will be trimmed from the value.
+ On Windows platforms environment variables with empty values are invalid so
+ set this variable to one or more spaces to disable persistent REPL history.
- `NODE_REPL_HISTORY_SIZE` - Controls how many lines of history will be
persisted if history is available. Must be a positive number.
**Default:** `1000`.