Skip to content

Commit

Permalink
doc: fix LTS replaceme tags
Browse files Browse the repository at this point in the history
When cherry-picking release commits for LTS releases into master,
the `REPLACEME` metadata can be taken over as well, to give users
a more accurate view of what is being released on which release line.

This addresses this problem for all previous LTS releases for which
this has not been done.

Fixes: #33001

PR-URL: #33041
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
  • Loading branch information
addaleax committed Apr 28, 2020
1 parent 039c5e4 commit 9c7c876
Show file tree
Hide file tree
Showing 27 changed files with 363 additions and 127 deletions.
12 changes: 9 additions & 3 deletions doc/api/assert.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ invariants.
<!-- YAML
added: v9.9.0
changes:
- version: v13.9.0
- version:
- v13.9.0
- v12.16.2
description: Changed "strict mode" to "strict assertion mode" and "legacy
mode" to "legacy assertion mode" to avoid confusion with the
more usual meaining of "strict mode".
Expand Down Expand Up @@ -564,7 +566,9 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the

## `assert.doesNotMatch(string, regexp[, message])`
<!-- YAML
added: v13.6.0
added:
- v13.6.0
- v12.16.0
-->

* `string` {string}
Expand Down Expand Up @@ -911,7 +915,9 @@ let err;

## `assert.match(string, regexp[, message])`
<!-- YAML
added: v13.6.0
added:
- v13.6.0
- v12.16.0
-->

* `string` {string}
Expand Down
16 changes: 12 additions & 4 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -1341,7 +1341,9 @@ The `buf.parent` property is a deprecated alias for `buf.buffer`.
### `buf.readBigInt64BE([offset])`
### `buf.readBigInt64LE([offset])`
<!-- YAML
added: v12.0.0
added:
- v12.0.0
- v10.20.0
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must
Expand All @@ -1357,7 +1359,9 @@ Integers read from a `Buffer` are interpreted as two's complement signed values.
### `buf.readBigUInt64BE([offset])`
### `buf.readBigUInt64LE([offset])`
<!-- YAML
added: v12.0.0
added:
- v12.0.0
- v10.20.0
-->

* `offset` {integer} Number of bytes to skip before starting to read. Must
Expand Down Expand Up @@ -2027,7 +2031,9 @@ console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
### `buf.writeBigInt64BE(value[, offset])`
### `buf.writeBigInt64LE(value[, offset])`
<!-- YAML
added: v12.0.0
added:
- v12.0.0
- v10.20.0
-->

* `value` {bigint} Number to be written to `buf`.
Expand All @@ -2053,7 +2059,9 @@ console.log(buf);
### `buf.writeBigUInt64BE(value[, offset])`
### `buf.writeBigUInt64LE(value[, offset])`
<!-- YAML
added: v12.0.0
added:
- v12.0.0
- v10.20.0
-->

* `value` {bigint} Number to be written to `buf`.
Expand Down
12 changes: 9 additions & 3 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,9 @@ arbitrary command execution.**
<!-- YAML
added: v0.5.0
changes:
- version: v13.2.0
- version:
- v13.2.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/30162
description: The `serialization` option is supported now.
- version: v8.0.0
Expand Down Expand Up @@ -400,7 +402,9 @@ The `shell` option available in [`child_process.spawn()`][] is not supported by
<!-- YAML
added: v0.1.90
changes:
- version: v13.2.0
- version:
- v13.2.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/30162
description: The `serialization` option is supported now.
- version: v8.8.0
Expand Down Expand Up @@ -1556,7 +1560,9 @@ unavailable.

## Advanced Serialization
<!-- YAML
added: v13.2.0
added:
- v13.2.0
- v12.16.0
-->

Child processes support a serialization mechanism for IPC that is based on the
Expand Down
53 changes: 40 additions & 13 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,9 @@ Currently, overriding `Error.prepareStackTrace` is ignored when the

### `--experimental-import-meta-resolve`
<!-- YAML
added: v13.9.0
added:
- v13.9.0
- v12.16.2
-->

Enable experimental `import.meta.resolve()` support.
Expand Down Expand Up @@ -210,7 +212,9 @@ Enable experimental top-level `await` keyword support in REPL.

### `--experimental-specifier-resolution=mode`
<!-- YAML
added: v13.4.0
added:
- v13.4.0
- v12.16.0
-->

Sets the resolution algorithm for resolving ES module specifiers. Valid options
Expand All @@ -231,7 +235,9 @@ Enable experimental ES Module support in the `vm` module.

### `--experimental-wasi-unstable-preview1`
<!-- YAML
added: v13.3.0
added:
- v13.3.0
- v12.16.0
changes:
- version: v13.6.0
pr-url: https://github.com/nodejs/node/pull/30980
Expand Down Expand Up @@ -417,7 +423,10 @@ endpoint on `http://host:port/json/list`.

### `--insecure-http-parser`
<!-- YAML
added: v13.4.0
added:
- v13.4.0
- v12.15.0
- v10.19.0
-->

Use an insecure HTTP parser that accepts invalid HTTP headers. This may allow
Expand All @@ -439,7 +448,9 @@ disappear in a non-semver-major release.

### `--max-http-header-size=size`
<!-- YAML
added: v11.6.0
added:
- v11.6.0
- v10.15.0
changes:
- version: v13.13.0
pr-url: https://github.com/nodejs/node/pull/32520
Expand Down Expand Up @@ -737,7 +748,9 @@ with crypto support (default).

### `--tls-keylog=file`
<!-- YAML
added: v13.2.0
added:
- v13.2.0
- v12.16.0
-->

Log TLS key material to a file. The key material is in NSS `SSLKEYLOGFILE`
Expand All @@ -746,7 +759,9 @@ traffic.

### `--tls-max-v1.2`
<!-- YAML
added: v12.0.0
added:
- v12.0.0
- v10.20.0
-->

Set [`tls.DEFAULT_MAX_VERSION`][] to 'TLSv1.2'. Use to disable support for
Expand All @@ -762,23 +777,29 @@ for TLSv1.3.

### `--tls-min-v1.0`
<!-- YAML
added: v12.0.0
added:
- v12.0.0
- v10.20.0
-->

Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1'. Use for compatibility with
old TLS clients or servers.

### `--tls-min-v1.1`
<!-- YAML
added: v12.0.0
added:
- v12.0.0
- v10.20.0
-->

Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1.1'. Use for compatibility
with old TLS clients or servers.

### `--tls-min-v1.2`
<!-- YAML
added: v12.2.0
added:
- v12.2.0
- v10.20.0
-->

Set default [`tls.DEFAULT_MIN_VERSION`][] to 'TLSv1.2'. This is the default for
Expand Down Expand Up @@ -825,7 +846,9 @@ Enables the collection of trace event tracing information.

### `--trace-exit`
<!-- YAML
added: v13.5.0
added:
- v13.5.0
- v12.16.0
-->

Prints a stack trace whenever an environment is exited proactively,
Expand Down Expand Up @@ -882,7 +905,9 @@ Track heap object allocations for heap snapshots.

### `--unhandled-rejections=mode`
<!-- YAML
added: v12.0.0
added:
- v12.0.0
- v10.17.0
-->

By default all unhandled rejections trigger a warning plus a deprecation warning
Expand Down Expand Up @@ -1273,7 +1298,9 @@ to an empty string (`''` or `' '`) disables persistent REPL history.

### `NODE_REPL_EXTERNAL_MODULE=file`
<!-- YAML
added: v13.0.0
added:
- v13.0.0
- v12.16.0
-->

Path to a Node.js module which will be loaded in place of the built-in REPL.
Expand Down
4 changes: 3 additions & 1 deletion doc/api/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -724,7 +724,9 @@ values are `'rr'` and `'none'`.
<!-- YAML
added: v0.7.1
changes:
- version: v13.2.0
- version:
- v13.2.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/30162
description: The `serialization` option is supported now.
- version: v9.5.0
Expand Down
16 changes: 12 additions & 4 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -1674,7 +1674,9 @@ changes:
- version: v11.6.0
pr-url: https://github.com/nodejs/node/pull/24234
description: The `key` argument can now be a `KeyObject`.
- version: v11.2.0
- version:
- v11.2.0
- v10.17.0
pr-url: https://github.com/nodejs/node/pull/24081
description: The cipher `chacha20-poly1305` is now supported.
- version: v10.10.0
Expand Down Expand Up @@ -1768,7 +1770,9 @@ changes:
- version: v11.6.0
pr-url: https://github.com/nodejs/node/pull/24234
description: The `key` argument can now be a `KeyObject`.
- version: v11.2.0
- version:
- v11.2.0
- v10.17.0
pr-url: https://github.com/nodejs/node/pull/24081
description: The cipher `chacha20-poly1305` is now supported.
- version: v10.10.0
Expand Down Expand Up @@ -2781,7 +2785,9 @@ request.
<!-- YAML
added: v10.5.0
changes:
- version: v12.8.0
- version:
- v12.8.0
- v10.17.0
pr-url: https://github.com/nodejs/node/pull/28799
description: The `maxmem` value can now be any safe integer.
- version: v10.9.0
Expand Down Expand Up @@ -2839,7 +2845,9 @@ crypto.scrypt('secret', 'salt', 64, { N: 1024 }, (err, derivedKey) => {
<!-- YAML
added: v10.5.0
changes:
- version: v12.8.0
- version:
- v12.8.0
- v10.17.0
pr-url: https://github.com/nodejs/node/pull/28799
description: The `maxmem` value can now be any safe integer.
- version: v10.9.0
Expand Down
4 changes: 3 additions & 1 deletion doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -2569,7 +2569,9 @@ and [`fs.createReadStream()`][]) or by passing a file descriptor in options.
### DEP0136: `http` `finished`
<!-- YAML
changes:
- version: v13.4.0
- version:
- v13.4.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/28679
description: Documentation-only deprecation.
-->
Expand Down
8 changes: 6 additions & 2 deletions doc/api/dgram.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,9 @@ if (cluster.isMaster) {

### `socket.addSourceSpecificMembership(sourceAddress, groupAddress[, multicastInterface])`
<!-- YAML
added: v13.1.0
added:
- v13.1.0
- v12.16.0
-->
* `sourceAddress` {string}
* `groupAddress` {string}
Expand Down Expand Up @@ -317,7 +319,9 @@ drop membership on all valid interfaces.

### `socket.dropSourceSpecificMembership(sourceAddress, groupAddress[, multicastInterface])`
<!-- YAML
added: v13.1.0
added:
- v13.1.0
- v12.16.0
-->

* `sourceAddress` {string}
Expand Down
4 changes: 3 additions & 1 deletion doc/api/errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -2151,7 +2151,9 @@ Creation of a [`zlib`][] object failed due to incorrect configuration.
### `HPE_HEADER_OVERFLOW`
<!-- YAML
changes:
- version: v11.4.0
- version:
- v11.4.0
- v10.15.0
pr-url: https://github.com/nodejs/node/commit/186035243fad247e3955f
description: Max header size in `http_parser` was set to 8KB.
-->
Expand Down
Loading

0 comments on commit 9c7c876

Please sign in to comment.