Skip to content

Commit

Permalink
doc,worker: deprecate --trace-atomics-wait
Browse files Browse the repository at this point in the history
V8 has asked if it possible to remove the functionality underlying
`--trace-atomics-wait`. Let's start with a documentation-only
deprecation.

Refs: nodejs#42982
  • Loading branch information
kvakil committed Aug 2, 2022
1 parent 07d7e1b commit 8ddb975
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
3 changes: 3 additions & 0 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -1244,8 +1244,11 @@ for TLSv1.2, which is not as secure as TLSv1.3.

<!-- YAML
added: v14.3.0
deprecated: REPLACEME
-->

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

Expand Down
14 changes: 14 additions & 0 deletions doc/api/deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -3177,13 +3177,27 @@ Type: Documentation-only
`code` values other than `undefined`, `null`, integer numbers and integer
strings (e.g., '1') are deprecated as parameter in [`process.exit()`][].

### DEP0165: `--trace-atomics-wait`

<!-- YAML
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/44093
description: Documentation-only deprecation.
-->

Type: Documentation-only

The [`--trace-atomics-wait`][] flag is deprecated.

[Legacy URL API]: url.md#legacy-url-api
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3
[WHATWG URL API]: url.md#the-whatwg-url-api
[`"exports"` or `"main"` entry]: packages.md#main-entry-point-export
[`--pending-deprecation`]: cli.md#--pending-deprecation
[`--throw-deprecation`]: cli.md#--throw-deprecation
[`--trace-atomics-wait`]: cli.md#--trace-atomics-wait
[`--unhandled-rejections`]: cli.md#--unhandled-rejectionsmode
[`Buffer.allocUnsafeSlow(size)`]: buffer.md#static-method-bufferallocunsafeslowsize
[`Buffer.from(array)`]: buffer.md#static-method-bufferfromarray
Expand Down
1 change: 1 addition & 0 deletions doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -435,6 +435,7 @@ favour of TLSv1.3, which is more secure.
Print short summaries of calls to
.Sy Atomics.wait() .
.
This flag is deprecated.
.It Fl -trace-deprecation
Print stack traces for deprecations.
.
Expand Down

0 comments on commit 8ddb975

Please sign in to comment.