Skip to content

Commit 4ec3fac

Browse files
kvakilFyko
authored andcommitted
doc,worker: deprecate --trace-atomics-wait
V8 has asked if it possible to remove the functionality underlying `--trace-atomics-wait`. Let's start with a documentation-only deprecation. PR-URL: nodejs#44093 Refs: nodejs#42982 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Feng Yu <[email protected]>
1 parent 2a35130 commit 4ec3fac

File tree

4 files changed

+19
-1
lines changed

4 files changed

+19
-1
lines changed

doc/api/cli.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1316,8 +1316,11 @@ for TLSv1.2, which is not as secure as TLSv1.3.
13161316

13171317
<!-- YAML
13181318
added: v14.3.0
1319+
deprecated: REPLACEME
13191320
-->
13201321

1322+
> Stability: 0 - Deprecated
1323+
13211324
Print short summaries of calls to [`Atomics.wait()`][] to stderr.
13221325
The output could look like this:
13231326

doc/api/deprecations.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3177,13 +3177,27 @@ Type: Documentation-only
31773177
`code` values other than `undefined`, `null`, integer numbers and integer
31783178
strings (e.g., '1') are deprecated as parameter in [`process.exit()`][].
31793179

3180+
### DEP0165: `--trace-atomics-wait`
3181+
3182+
<!-- YAML
3183+
changes:
3184+
- version: REPLACEME
3185+
pr-url: https://github.com/nodejs/node/pull/44093
3186+
description: Documentation-only deprecation.
3187+
-->
3188+
3189+
Type: Documentation-only
3190+
3191+
The [`--trace-atomics-wait`][] flag is deprecated.
3192+
31803193
[Legacy URL API]: url.md#legacy-url-api
31813194
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
31823195
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
31833196
[WHATWG URL API]: url.md#the-whatwg-url-api
31843197
[`"exports"` or `"main"` entry]: packages.md#main-entry-point-export
31853198
[`--pending-deprecation`]: cli.md#--pending-deprecation
31863199
[`--throw-deprecation`]: cli.md#--throw-deprecation
3200+
[`--trace-atomics-wait`]: cli.md#--trace-atomics-wait
31873201
[`--unhandled-rejections`]: cli.md#--unhandled-rejectionsmode
31883202
[`Buffer.allocUnsafeSlow(size)`]: buffer.md#static-method-bufferallocunsafeslowsize
31893203
[`Buffer.from(array)`]: buffer.md#static-method-bufferfromarray

doc/node.1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,7 @@ favour of TLSv1.3, which is more secure.
435435
Print short summaries of calls to
436436
.Sy Atomics.wait() .
437437
.
438+
This flag is deprecated.
438439
.It Fl -trace-deprecation
439440
Print stack traces for deprecations.
440441
.

src/node_options.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -540,7 +540,7 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
540540
&EnvironmentOptions::throw_deprecation,
541541
kAllowedInEnvironment);
542542
AddOption("--trace-atomics-wait",
543-
"trace Atomics.wait() operations",
543+
"(deprecated) trace Atomics.wait() operations",
544544
&EnvironmentOptions::trace_atomics_wait,
545545
kAllowedInEnvironment);
546546
AddOption("--trace-deprecation",

0 commit comments

Comments
 (0)