Commit 8a627b1
doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset.
Refs: #18417
PR-URL: #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>1 parent b76e111 commit 8a627b1
1 file changed
Lines changed: 5 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -368,7 +368,10 @@ Node.js uses three Deprecation levels: | |||
| 368 | 368 | being staged for deprecation in a future Node.js major release. An explicit | |
| 369 | 369 | notice indicating the deprecated status is added to the API documentation | |
| 370 | 370 | but no functional changes are implemented in the code. There will be no | |
| 371 | - runtime deprecation warnings emitted for such deprecations. | ||
| 371 | + runtime deprecation warnings emitted for such deprecations by default. | ||
| 372 | + Documentation-only deprecations may trigger a runtime warning when launched | ||
| 373 | + with [`--pending-deprecation`][] flag (or its alternative, | ||
| 374 | + `NODE_PENDING_DEPRECATION=1` environment variable). | ||
| 372 | 375 | ||
| 373 | 376 | * *Runtime Deprecation* refers to the use of process warnings emitted at | |
| 374 | 377 | runtime the first time that a deprecated API is used. A command-line | |
@@ -744,6 +747,7 @@ LTS working group and the Release team. | |||
| 744 | 747 | [backporting guide]: doc/guides/backporting-to-release-lines.md | |
| 745 | 748 | [Stability Index]: doc/api/documentation.md#stability-index | |
| 746 | 749 | [Enhancement Proposal]: https://github.com/nodejs/node-eps | |
| 750 | + [`--pending-deprecation`]: doc/api/cli.md#--pending-deprecation | ||
| 747 | 751 | [git-username]: https://help.github.com/articles/setting-your-username-in-git/ | |
| 748 | 752 | [`node-core-utils`]: https://github.com/nodejs/node-core-utils | |
| 749 | 753 | [TSC]: https://github.com/nodejs/TSC | |
0 commit comments