From 579b5cfb710e6d2ba78849769b5ca2384262bf6f Mon Sep 17 00:00:00 2001
From: Keyhan Vakil <kvakil@sylph.kvakil.me>
Date: Wed, 3 Aug 2022 22:37:59 -0700
Subject: [PATCH] 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: https://github.com/nodejs/node/pull/44093
Refs: https://github.com/nodejs/node/issues/42982
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Feng Yu <F3n67u@outlook.com>
---
 doc/api/cli.md          |  3 +++
 doc/api/deprecations.md | 14 ++++++++++++++
 doc/node.1              |  1 +
 src/node_options.cc     |  2 +-
 4 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index c61cb96f231..ae12e9269c9 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1195,8 +1195,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
index 5a356b8d048..35c65cbb841 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -3134,6 +3134,19 @@ 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
@@ -3141,6 +3154,7 @@ strings (e.g., '1') are deprecated as parameter in [`process.exit()`][].
 [`"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
index 602c812c92f..871a74d25bd 100644
--- a/doc/node.1
+++ b/doc/node.1
@@ -429,6 +429,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
index b82100b6907..8b339aa7655 100644
--- a/src/node_options.cc
+++ b/src/node_options.cc
@@ -539,7 +539,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",