summaryrefslogtreecommitdiff
path: root/test/README.md
diff options
context:
space:
mode:
authorBartosz Sosnowski <bartosz@janeasystems.com>2018-05-15 20:45:17 +0200
committerAnatoli Papirovski <apapirovski@mac.com>2018-05-22 12:28:57 +0400
commit3654cd4cdaf2ab84d0e6a190c3b9e89e86726a88 (patch)
tree0332891c19a453a06c59da1ee74b8fa7c8bdc536 /test/README.md
parent731c55a08e6f91ac44d860243ce52ebbc380cb62 (diff)
downloadandroid-node-v8-3654cd4cdaf2ab84d0e6a190c3b9e89e86726a88.tar.gz
android-node-v8-3654cd4cdaf2ab84d0e6a190c3b9e89e86726a88.tar.bz2
android-node-v8-3654cd4cdaf2ab84d0e6a190c3b9e89e86726a88.zip
doc: add note about autocrlf required for tests
Adds a note to test/README.md that setting autocrlf to true when checking out sources is required for the tests to run successfully. PR-URL: https://github.com/nodejs/node/pull/20752 Ref: https://github.com/nodejs/node/issues/18967 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Diffstat (limited to 'test/README.md')
-rw-r--r--test/README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/test/README.md b/test/README.md
index bc2464bcfa..302db9d0bb 100644
--- a/test/README.md
+++ b/test/README.md
@@ -8,6 +8,9 @@ directory, see [the guide on writing tests](../doc/guides/writing-tests.md).
On how to run tests in this directory, see
[the contributing guide](../doc/guides/contributing/pull-requests.md#step-6-test).
+For the tests to successfully run on Windows, Node.js has to be checked out from
+GitHub with the `autocrlf` git config flag set to true.
+
## Test Directories
|Directory |Runs on CI |Purpose |