diff options
author | cjihrig <cjihrig@gmail.com> | 2020-03-13 06:24:01 +0300 |
---|---|---|
committer | cjihrig <cjihrig@gmail.com> | 2020-03-15 20:29:34 +0300 |
commit | 9d1a3b6f608d864f3e4b1e8dc667f733f5acdcb8 (patch) | |
tree | bc2295a96760ba4ce99f26e9b03d48a70cc70352 /doc/api | |
parent | 4c64e7c59a655142367a361bae873683208b9f9b (diff) |
doc,lib,src,test: make --experimental-report a nop
This commit makes the --experimental-report CLI flag a no-op.
PR-URL: https://github.com/nodejs/node/pull/32242
Fixes: https://github.com/nodejs/node/issues/26293
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/cli.md | 24 | ||||
-rw-r--r-- | doc/api/report.md | 11 |
2 files changed, 11 insertions, 24 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md index 66cb665fa82..9a023bbb488 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -199,13 +199,6 @@ added: v10.0.0 Enable experimental top-level `await` keyword support in REPL. -### `--experimental-report` -<!-- YAML -added: v11.8.0 ---> - -Enable experimental diagnostic report feature. - ### `--experimental-specifier-resolution=mode` <!-- YAML added: v13.4.0 @@ -635,9 +628,9 @@ changes: Enables the report to be triggered on fatal errors (internal errors within the Node.js runtime such as out of memory) that lead to termination of the -application, if `--experimental-report` is enabled. Useful to inspect various -diagnostic data elements such as heap, stack, event loop state, resource -consumption etc. to reason about the fatal error. +application. Useful to inspect various diagnostic data elements such as heap, +stack, event loop state, resource consumption etc. to reason about the fatal +error. ### `--report-on-signal` <!-- YAML @@ -650,8 +643,8 @@ changes: --> Enables report to be generated upon receiving the specified (or predefined) -signal to the running Node.js process, if `--experimental-report` is enabled. -The signal to trigger the report is specified through `--report-signal`. +signal to the running Node.js process. The signal to trigger the report is +specified through `--report-signal`. ### `--report-signal=signal` <!-- YAML @@ -676,9 +669,9 @@ changes: `--report-uncaught-exception` --> -Enables report to be generated on un-caught exceptions, if -`--experimental-report` is enabled. Useful when inspecting JavaScript stack in -conjunction with native stack and other runtime environment data. +Enables report to be generated on uncaught exceptions. Useful when inspecting +the JavaScript stack in conjunction with native stack and other runtime +environment data. ### `--throw-deprecation` <!-- YAML @@ -1098,7 +1091,6 @@ Node.js options that are allowed are: * `--experimental-modules` * `--experimental-policy` * `--experimental-repl-await` -* `--experimental-report` * `--experimental-specifier-resolution` * `--experimental-vm-modules` * `--experimental-wasi-unstable-preview1` diff --git a/doc/api/report.md b/doc/api/report.md index a292d0a0582..976d470bc59 100644 --- a/doc/api/report.md +++ b/doc/api/report.md @@ -32,7 +32,6 @@ is provided below for reference. "cwd": "/home/nodeuser/project/node", "commandLine": [ "/home/nodeuser/project/node/out/Release/node", - "--experimental-report", "--report-uncaught-exception", "/home/nodeuser/project/node/test/report/test-exception.js", "child" @@ -392,14 +391,10 @@ is provided below for reference. ## Usage ```bash -node --experimental-report --report-uncaught-exception \ - --report-on-signal --report-on-fatalerror app.js +node --report-uncaught-exception --report-on-signal \ +--report-on-fatalerror app.js ``` -* `--experimental-report` Enables the diagnostic report feature. - In the absence of this flag, use of all other related options will result in - an error. - * `--report-uncaught-exception` Enables report to be generated on un-caught exceptions. Useful when inspecting JavaScript stack in conjunction with native stack and other runtime environment data. @@ -569,7 +564,7 @@ Configuration on module initialization is also available via environment variables: ```bash -NODE_OPTIONS="--experimental-report --report-uncaught-exception \ +NODE_OPTIONS="--report-uncaught-exception \ --report-on-fatalerror --report-on-signal \ --report-signal=SIGUSR2 --report-filename=./report.json \ --report-directory=/home/nodeuser" |