doc,worker: deprecate --trace-atomics-wait

kvakil · ruyadorno · commit da7bc5acdf25 · 2022-08-22T19:37:15.000-04:00
V8 has asked if it possible to remove the functionality underlying `--trace-atomics-wait`. Let's start with a documentation-only deprecation. PR-URL: #44093 Refs: #42982 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Feng Yu <F3n67u@outlook.com>
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -1217,8 +1217,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:
 
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
@@ -3169,13 +3169,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
diff --git a/doc/node.1 b/doc/node.1
@@ -432,6 +432,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.
 .
diff --git a/src/node_options.cc b/src/node_options.cc
@@ -540,7 +540,7 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
             &EnvironmentOptions::throw_deprecation,
             kAllowedInEnvironment);
   AddOption("--trace-atomics-wait",
-            "trace Atomics.wait() operations",
+            "(deprecated) trace Atomics.wait() operations",
             &EnvironmentOptions::trace_atomics_wait,
             kAllowedInEnvironment);
   AddOption("--trace-deprecation",

Original file line number	Diff line number	Diff line change
`@@ -432,6 +432,7 @@ favour of TLSv1.3, which is more secure.`
`432`	`432`	`Print short summaries of calls to`
`433`	`433`	`.Sy Atomics.wait() .`
`434`	`434`	`.`
	`435`	`+This flag is deprecated.`
`435`	`436`	`.It Fl -trace-deprecation`
`436`	`437`	`Print stack traces for deprecations.`
`437`	`438`	`.`