diff options
| -rw-r--r-- | BUILDING.md | 20 | ||||
| -rw-r--r-- | doc/api/fs.md | 20 | ||||
| -rw-r--r-- | doc/api/util.md | 18 | ||||
| -rw-r--r-- | doc/guides/diagnostic-tooling-support-tiers.md | 82 | ||||
| -rw-r--r-- | doc/guides/doc-style-guide.md | 30 | ||||
| -rw-r--r-- | test/async-hooks/coverage.md | 56 |
6 files changed, 113 insertions, 113 deletions
diff --git a/BUILDING.md b/BUILDING.md index dbe4fdcf35a..6452e3ebd78 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -167,16 +167,16 @@ Depending on the host platform, the selection of toolchains may vary. Binaries at <https://nodejs.org/download/release/> are produced on: -| Binary package | Platform and Toolchain | -| --------------------- | ------------------------------------------------------------------------ | -| aix-ppc64 | AIX 7.1 TL05 on PPC64BE with GCC 6 | -| darwin-x64 (and .pkg) | macOS 10.15, Xcode Command Line Tools 11 with -mmacosx-version-min=10.13 | -| linux-arm64 | CentOS 7 with devtoolset-8 / GCC 8 <sup>[8](#fn8)</sup> | -| linux-armv7l | Cross-compiled on Ubuntu 18.04 x64 with [custom GCC toolchain](https://github.com/rvagg/rpi-newer-crosstools) | -| linux-ppc64le | CentOS 7 with devtoolset-8 / GCC 8 <sup>[8](#fn8)</sup> | -| linux-s390x | RHEL 7 with devtoolset-8 / GCC 8 <sup>[8](#fn8)</sup> | -| linux-x64 | CentOS 7 with devtoolset-8 / GCC 8 <sup>[8](#fn8)</sup> | -| win-x64 and win-x86 | Windows 2012 R2 (x64) with Visual Studio 2019 | +| Binary package | Platform and Toolchain | +| --------------------- | ------------------------------------------------------------------------------------------------------------- | +| aix-ppc64 | AIX 7.1 TL05 on PPC64BE with GCC 6 | +| darwin-x64 (and .pkg) | macOS 10.15, Xcode Command Line Tools 11 with -mmacosx-version-min=10.13 | +| linux-arm64 | CentOS 7 with devtoolset-8 / GCC 8 <sup>[8](#fn8)</sup> | +| linux-armv7l | Cross-compiled on Ubuntu 18.04 x64 with [custom GCC toolchain](https://github.com/rvagg/rpi-newer-crosstools) | +| linux-ppc64le | CentOS 7 with devtoolset-8 / GCC 8 <sup>[8](#fn8)</sup> | +| linux-s390x | RHEL 7 with devtoolset-8 / GCC 8 <sup>[8](#fn8)</sup> | +| linux-x64 | CentOS 7 with devtoolset-8 / GCC 8 <sup>[8](#fn8)</sup> | +| win-x64 and win-x86 | Windows 2012 R2 (x64) with Visual Studio 2019 | <em id="fn8">8</em>: The Enterprise Linux devtoolset-8 allows us to compile binaries with GCC 8 but linked to the glibc and libstdc++ versions of the host diff --git a/doc/api/fs.md b/doc/api/fs.md index bcc5695284e..24768ac17f9 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -1511,16 +1511,16 @@ the permissions for the file owner. The middle digit (`6` in the example), specifies permissions for the group. The right-most digit (`5` in the example), specifies the permissions for others. -| Number | Description | -| ------- | ------------------------ | -| `7` | read, write, and execute | -| `6` | read and write | -| `5` | read and execute | -| `4` | read only | -| `3` | write and execute | -| `2` | write only | -| `1` | execute only | -| `0` | no permission | +| Number | Description | +| ------ | ------------------------ | +| `7` | read, write, and execute | +| `6` | read and write | +| `5` | read and execute | +| `4` | read only | +| `3` | write and execute | +| `2` | write only | +| `1` | execute only | +| `0` | no permission | For example, the octal value `0o765` means: diff --git a/doc/api/util.md b/doc/api/util.md index 134e263f005..1cd8fef07e2 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -1159,18 +1159,18 @@ Different Node.js build configurations support different sets of encodings. #### Encodings supported when Node.js is built with the `small-icu` option -| Encoding | Aliases | -| ----------- | --------------------------------- | -| `'utf-8'` | `'unicode-1-1-utf-8'`, `'utf8'` | -| `'utf-16le'` | `'utf-16'` | -| `'utf-16be'` | | +| Encoding | Aliases | +| ----------- | ------------------------------- | +| `'utf-8'` | `'unicode-1-1-utf-8'`, `'utf8'` | +| `'utf-16le'` | `'utf-16'` | +| `'utf-16be'` | | #### Encodings supported when ICU is disabled -| Encoding | Aliases | -| ----------- | --------------------------------- | -| `'utf-8'` | `'unicode-1-1-utf-8'`, `'utf8'` | -| `'utf-16le'` | `'utf-16'` | +| Encoding | Aliases | +| ----------- | ------------------------------- | +| `'utf-8'` | `'unicode-1-1-utf-8'`, `'utf8'` | +| `'utf-16le'` | `'utf-16'` | The `'iso-8859-16'` encoding listed in the [WHATWG Encoding Standard][] is not supported. diff --git a/doc/guides/diagnostic-tooling-support-tiers.md b/doc/guides/diagnostic-tooling-support-tiers.md index 5d935a29369..1bff8774562 100644 --- a/doc/guides/diagnostic-tooling-support-tiers.md +++ b/doc/guides/diagnostic-tooling-support-tiers.md @@ -93,56 +93,56 @@ The tools are currently assigned to Tiers as follows: ## Tier 1 - | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | - |-----------|---------------------------|-------------------------------|-------------------------|-------------| - | FFDC | diagnostic report | Yes | Yes | 1 | - | | | | | | +| Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | +|-----------|---------------------------|-------------------------------|-------------------------|-------------| +| FFDC | diagnostic report | Yes | Yes | 1 | +| | | | | | ## Tier 2 - | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | - |-----------|---------------------------|-------------------------------|-------------------------|-------------| - | | | | | | +| Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | +|-----------|---------------|-------------------------------|-------------------------|-------------| +| | | | | | ## Tier 3 - | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | - |-----------|--------------------------------------|-------------------------------|-------------------------|-------------| - | Profiling | V8 CPU profiler | Partial (V8 Tests) | Yes | 1 | - | Profiling | --prof/--prof-process flags | Yes | Yes | 1 | - | Profiling | V8 CodeEventHandler API | Partial (V8 Tests) | Yes | 2 | - | Profiling | V8 --interpreted-frames-native-stack | Yes | Yes | 2 | - | Profiling | Linux perf | Yes | Partial | 2 | +| Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | +|-----------|--------------------------------------|-------------------------------|-------------------------|-------------| +| Profiling | V8 CPU profiler | Partial (V8 Tests) | Yes | 1 | +| Profiling | --prof/--prof-process flags | Yes | Yes | 1 | +| Profiling | V8 CodeEventHandler API | Partial (V8 Tests) | Yes | 2 | +| Profiling | V8 --interpreted-frames-native-stack | Yes | Yes | 2 | +| Profiling | Linux perf | Yes | Partial | 2 | ## Tier 4 - | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | - |-----------|---------------------------|-------------------------------|-------------------------|-------------| - | | | | | | +| Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | +|-----------|---------------|-------------------------------|-------------------------|-------------| +| | | | | | ## Not yet classified - | Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | - |-----------|---------------------------|-------------------------------|-------------------------|-------------| - | FFDC | node-report | No | No | 1 | - | Memory | mdb_V8 | No | No | 4 | - | Memory | node-heapdump | No | No | 2 | - | Memory | V8 heap profiler | No | Yes | 1 | - | Memory | V8 sampling heap profiler | No | Yes | 1 | - | AsyncFlow | Async Hooks (API) | ? | Yes | 1 | - | Debugger | V8 Debug protocol (API) | No | Yes | 1 | - | Debugger | Command line Debug Client | ? | Yes | 1 | - | Debugger | llnode | ? | No | 2 | - | Debugger | Chrome Dev tools | ? | No | 3 | - | Debugger | Chakracore - time-travel | No | Data source only | too early | - | Tracing | trace_events (API) | No | Yes | 1 | - | Tracing | DTrace | No | Partial | 3 | - | Tracing | LTTng | No | Removed? | N/A | - | Tracing | ETW | No | Partial | 3 | - | Tracing | Systemtap | No | Partial | ? | - | Profiling | DTrace | No | Partial | 3 | - | Profiling | Windows Xperf | No | ? | ? | - | Profiling | 0x | No | No | 4 | - | Profiling | node-clinic | No | No | too early | - | F/P/T | appmetrics | No | No | ? | - | M/T | eBPF tracing tool | No | No | ? | +| Tool Type | Tool/API Name | Regular Testing in Node.js CI | Integrated with Node.js | Target Tier | +|-----------|---------------------------|-------------------------------|-------------------------|-------------| +| FFDC | node-report | No | No | 1 | +| Memory | mdb_V8 | No | No | 4 | +| Memory | node-heapdump | No | No | 2 | +| Memory | V8 heap profiler | No | Yes | 1 | +| Memory | V8 sampling heap profiler | No | Yes | 1 | +| AsyncFlow | Async Hooks (API) | ? | Yes | 1 | +| Debugger | V8 Debug protocol (API) | No | Yes | 1 | +| Debugger | Command line Debug Client | ? | Yes | 1 | +| Debugger | llnode | ? | No | 2 | +| Debugger | Chrome Dev tools | ? | No | 3 | +| Debugger | Chakracore - time-travel | No | Data source only | too early | +| Tracing | trace_events (API) | No | Yes | 1 | +| Tracing | DTrace | No | Partial | 3 | +| Tracing | LTTng | No | Removed? | N/A | +| Tracing | ETW | No | Partial | 3 | +| Tracing | Systemtap | No | Partial | ? | +| Profiling | DTrace | No | Partial | 3 | +| Profiling | Windows Xperf | No | ? | ? | +| Profiling | 0x | No | No | 4 | +| Profiling | node-clinic | No | No | too early | +| F/P/T | appmetrics | No | No | ? | +| M/T | eBPF tracing tool | No | No | ? | diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md index ee039e9e836..c5b5b80f2ac 100644 --- a/doc/guides/doc-style-guide.md +++ b/doc/guides/doc-style-guide.md @@ -39,21 +39,21 @@ this guide. * Use [language][]-aware fences. (<code>```js</code>) * For the [info string][], use one of the following. - | Meaning | Info string | - | ------------- | ----------------- | - | Bash | `bash` | - | C | `c` | - | C++ | `cpp` | - | CoffeeScript | `coffee` | - | Diff | `diff` | - | HTTP | `http` | - | JavaScript | `js` | - | JSON | `json` | - | Markdown | `markdown` | - | Plaintext | `text` | - | Powershell | `powershell` | - | R | `r` | - | Shell Session | `console` | + | Meaning | Info string | + | ------------- | ------------ | + | Bash | `bash` | + | C | `c` | + | C++ | `cpp` | + | CoffeeScript | `coffee` | + | Diff | `diff` | + | HTTP | `http` | + | JavaScript | `js` | + | JSON | `json` | + | Markdown | `markdown` | + | Plaintext | `text` | + | Powershell | `powershell` | + | R | `r` | + | Shell Session | `console` | If one of your language-aware fences needs an info string that is not already on this list, you may use `text` until the grammar gets added to diff --git a/test/async-hooks/coverage.md b/test/async-hooks/coverage.md index 1ba18a93833..5470297d206 100644 --- a/test/async-hooks/coverage.md +++ b/test/async-hooks/coverage.md @@ -2,31 +2,31 @@ Showing which kind of async resource is covered by which test: -| Resource Type | Test | -|----------------------|--------------------------------------------| -| CONNECTION | test-connection.ssl.js | -| FSEVENTWRAP | test-fseventwrap.js | -| FSREQCALLBACK | test-fsreqcallback-{access,readFile}.js | -| GETADDRINFOREQWRAP | test-getaddrinforeqwrap.js | -| GETNAMEINFOREQWRAP | test-getnameinforeqwrap.js | -| HTTPINCOMINGMESSAGE | test-httpparser.request.js | -| HTTPCLIENTREQUEST | test-httpparser.response.js | -| Immediate | test-immediate.js | -| JSSTREAM | TODO (crashes when accessing directly) | -| PBKDF2REQUEST | test-crypto-pbkdf2.js | -| PIPECONNECTWRAP | test-pipeconnectwrap.js | -| PIPEWRAP | test-pipewrap.js | -| PROCESSWRAP | test-pipewrap.js | -| QUERYWRAP | test-querywrap.js | -| RANDOMBYTESREQUEST | test-crypto-randomBytes.js | -| SHUTDOWNWRAP | test-shutdownwrap.js | -| SIGNALWRAP | test-signalwrap.js | -| STATWATCHER | test-statwatcher.js | -| TCPCONNECTWRAP | test-tcpwrap.js | -| TCPWRAP | test-tcpwrap.js | -| TLSWRAP | test-tlswrap.js | -| TTYWRAP | test-ttywrap.{read,write}stream.js | -| UDPSENDWRAP | test-udpsendwrap.js | -| UDPWRAP | test-udpwrap.js | -| WRITEWRAP | test-writewrap.js | -| ZLIB | test-zlib.zlib-binding.deflate.js | +| Resource Type | Test | +|---------------------|-----------------------------------------| +| CONNECTION | test-connection.ssl.js | +| FSEVENTWRAP | test-fseventwrap.js | +| FSREQCALLBACK | test-fsreqcallback-{access,readFile}.js | +| GETADDRINFOREQWRAP | test-getaddrinforeqwrap.js | +| GETNAMEINFOREQWRAP | test-getnameinforeqwrap.js | +| HTTPINCOMINGMESSAGE | test-httpparser.request.js | +| HTTPCLIENTREQUEST | test-httpparser.response.js | +| Immediate | test-immediate.js | +| JSSTREAM | TODO (crashes when accessing directly) | +| PBKDF2REQUEST | test-crypto-pbkdf2.js | +| PIPECONNECTWRAP | test-pipeconnectwrap.js | +| PIPEWRAP | test-pipewrap.js | +| PROCESSWRAP | test-pipewrap.js | +| QUERYWRAP | test-querywrap.js | +| RANDOMBYTESREQUEST | test-crypto-randomBytes.js | +| SHUTDOWNWRAP | test-shutdownwrap.js | +| SIGNALWRAP | test-signalwrap.js | +| STATWATCHER | test-statwatcher.js | +| TCPCONNECTWRAP | test-tcpwrap.js | +| TCPWRAP | test-tcpwrap.js | +| TLSWRAP | test-tlswrap.js | +| TTYWRAP | test-ttywrap.{read,write}stream.js | +| UDPSENDWRAP | test-udpsendwrap.js | +| UDPWRAP | test-udpwrap.js | +| WRITEWRAP | test-writewrap.js | +| ZLIB | test-zlib.zlib-binding.deflate.js | |