diff options
| author | Сковорода Никита Андреевич <chalkerx@gmail.com> | 2018-01-29 20:10:31 +0300 |
|---|---|---|
| committer | Сковорода Никита Андреевич <chalkerx@gmail.com> | 2018-01-31 01:18:26 +0300 |
| commit | c276851b2f0074a7402115d5336737f84726fa9c (patch) | |
| tree | 4970bd933c92eb09701225459a04a1bb10c70dc9 | |
| parent | e56189ed58903f63a3d9d877d98b3bbcbc432710 (diff) | |
| download | node-new-c276851b2f0074a7402115d5336737f84726fa9c.tar.gz | |
doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.
Refs: https://github.com/nodejs/node/issues/18417
PR-URL: https://github.com/nodejs/node/pull/18433
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 5a1d51dafe..e00437ee7c 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -368,7 +368,10 @@ Node.js uses three Deprecation levels: being staged for deprecation in a future Node.js major release. An explicit notice indicating the deprecated status is added to the API documentation but no functional changes are implemented in the code. There will be no - runtime deprecation warnings emitted for such deprecations. + runtime deprecation warnings emitted for such deprecations by default. + Documentation-only deprecations may trigger a runtime warning when launched + with [`--pending-deprecation`][] flag (or its alternative, + `NODE_PENDING_DEPRECATION=1` environment variable). * *Runtime Deprecation* refers to the use of process warnings emitted at runtime the first time that a deprecated API is used. A command-line @@ -744,6 +747,7 @@ LTS working group and the Release team. [backporting guide]: doc/guides/backporting-to-release-lines.md [Stability Index]: doc/api/documentation.md#stability-index [Enhancement Proposal]: https://github.com/nodejs/node-eps +[`--pending-deprecation`]: doc/api/cli.md#--pending-deprecation [git-username]: https://help.github.com/articles/setting-your-username-in-git/ [`node-core-utils`]: https://github.com/nodejs/node-core-utils [TSC]: https://github.com/nodejs/TSC |