From 7937fbe3bc660d481b48fa1bdbe8a6edc08baf7f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Tue, 3 Nov 2020 05:02:22 -0800 Subject: [PATCH] doc: update tables in README files for linting changes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/35905 Reviewed-By: Franziska Hinkelmann Reviewed-By: Shelley Vohr Reviewed-By: Michaël Zasso --- src/README.md | 20 ++++++++++---------- test/README.md | 48 ++++++++++++++++++++++++------------------------ 2 files changed, 34 insertions(+), 34 deletions(-) diff --git a/src/README.md b/src/README.md index e81f1e1c70b781..3289eec27ff8de 100644 --- a/src/README.md +++ b/src/README.md @@ -495,16 +495,16 @@ The most common reasons for this are: holds a value of type `Local`. It has methods that perform the same operations as the methods of `v8::Maybe`, but with different names: -| `Maybe` | `MaybeLocal` | -| ---------------------- | ------------------------------- | -| `maybe.IsNothing()` | `maybe_local.IsEmpty()` | -| `maybe.IsJust()` | `!maybe_local.IsEmpty()` | -| `maybe.To(&value)` | `maybe_local.ToLocal(&local)` | -| `maybe.ToChecked()` | `maybe_local.ToLocalChecked()` | -| `maybe.FromJust()` | `maybe_local.ToLocalChecked()` | -| `maybe.Check()` | – | -| `v8::Nothing()` | `v8::MaybeLocal()` | -| `v8::Just(value)` | `v8::MaybeLocal(value)` | +| `Maybe` | `MaybeLocal` | +| -------------------- | ------------------------------ | +| `maybe.IsNothing()` | `maybe_local.IsEmpty()` | +| `maybe.IsJust()` | `!maybe_local.IsEmpty()` | +| `maybe.To(&value)` | `maybe_local.ToLocal(&local)` | +| `maybe.ToChecked()` | `maybe_local.ToLocalChecked()` | +| `maybe.FromJust()` | `maybe_local.ToLocalChecked()` | +| `maybe.Check()` | – | +| `v8::Nothing()` | `v8::MaybeLocal()` | +| `v8::Just(value)` | `v8::MaybeLocal(value)` | ##### Handling empty `Maybe`s diff --git a/test/README.md b/test/README.md index ad9d87a7e93051..a9569235fdde1b 100644 --- a/test/README.md +++ b/test/README.md @@ -13,27 +13,27 @@ For the tests to run on Windows, be sure to clone Node.js source code with the ## 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. | -| `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. | -| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. | -| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) | -| `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 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. 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 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. | +| 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. | +| `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. | +| `code-cache` | No | Tests for a Node.js binary compiled with V8 code cache. | +| `common` | | Common modules shared among many tests. [Documentation](./common/README.md) | +| `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 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. 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 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. |