From f60afa6269afd640cad151228cb216b0273689a0 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Thu, 9 May 2019 14:02:48 -0700 Subject: [PATCH] doc: simplify test/README.md Simplify phrasing in test/README.md. PR-URL: https://github.com/nodejs/node/pull/27630 Reviewed-By: Richard Lau Reviewed-By: Colin Ihrig Reviewed-By: Ruben Bridgewater Reviewed-By: Anto Aravinth Reviewed-By: James M Snell --- test/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/test/README.md b/test/README.md index 8b496f4875f6d5..fcfafb492bc5d8 100644 --- a/test/README.md +++ b/test/README.md @@ -8,15 +8,15 @@ 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. +For the tests to run on Windows, be sure to clone Node.js source code with the +`autocrlf` git config flag set to true. ## Test Directories | Directory | Runs on CI | Purpose | | ------------------- | --------------- | --------------- | | `abort` | Yes | Tests for when the ``` --abort-on-uncaught-exception ``` flag is used. | -| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon to function properly. | +| `addons` | Yes | Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon. | | `async-hooks` | Yes | Tests for [async_hooks](https://nodejs.org/api/async_hooks.html) functionality. | | `benchmark` | No | Test minimal functionality of benchmarks. | | `cctest` | Yes | C++ tests that are run as part of the build process. | @@ -25,15 +25,15 @@ GitHub with the `autocrlf` git config flag set to true. | `doctool` | Yes | Tests for the documentation generator. | | `es-module` | Yes | Test ESM module loading. | | `fixtures` | | Test fixtures used in various tests throughout the test suite. | -| `internet` | No | Tests that make real outbound connections (mainly networking related modules). Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. | +| `internet` | No | Tests that make real outbound network connections. Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. | | `js-native-api` | Yes | Tests for Node.js-agnostic [n-api](https://nodejs.org/api/n-api.html) functionality. | -| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail consistently. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. | +| `known_issues` | Yes | Tests reproducing known issues within the system. All tests inside of this directory are expected to fail. If a test doesn't fail on certain platforms, those should be skipped via `known_issues.status`. | | `message` | Yes | Tests for messages that are output for various conditions (```console.log```, error messages etc.) | | `node-api` | Yes | Tests for Node.js-specific [n-api](https://nodejs.org/api/n-api.html) functionality. | | `parallel` | Yes | Various tests that are able to be run in parallel. | | `pseudo-tty` | Yes | Tests that require stdin/stdout/stderr to be a TTY. | | `pummel` | No | Various tests for various modules / system functionality operating under load. | -| `sequential` | Yes | Various tests that are run sequentially. | +| `sequential` | Yes | Various tests that must not run in parallel. | | `testpy` | | Test configuration utility used by various test suites. | | `tick-processor` | No | Tests for the V8 tick processor integration. The tests are for the logic in ```lib/internal/v8_prof_processor.js``` and ```lib/internal/v8_prof_polyfill.js```. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic. | | `v8-updates` | No | Tests for V8 performance integration. |