summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2019-02-18 14:01:12 -0500
committerRod Vagg <rod@vagg.org>2019-02-28 23:35:35 +1100
commit8a404686357d8eeb8a4997fe4626e2aed46f9c78 (patch)
tree9c1a793fd8508865589b454f8a7e9955bdc371c1 /doc
parent0e89d7add6e75ac1ac35d63bc5c76922f630c3bf (diff)
downloadnode-new-8a404686357d8eeb8a4997fe4626e2aed46f9c78.tar.gz
report: remove verbose setting
This commit removes the --diagnostic-report-verbose CLI option and all associated logic. The flag is currently only used in one place, and only reflects the settings at startup. Additionally, Node tends to use the NODE_DEBUG mechanism for adding verbose output. PR-URL: https://github.com/nodejs/node/pull/26195 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/cli.md8
-rw-r--r--doc/api/process.md5
-rw-r--r--doc/api/report.md11
-rw-r--r--doc/node.15
4 files changed, 2 insertions, 27 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md
index 300e018220..71e36a4c12 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -126,13 +126,6 @@ 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.
-### `--diagnostic-report-verbose`
-<!-- YAML
-added: v11.8.0
--->
-
-Flag that enables additional information to be printed during report generation.
-
### `--enable-fips`
<!-- YAML
added: v6.0.0
@@ -672,7 +665,6 @@ Node.js options that are allowed are:
- `--diagnostic-report-on-signal`
- `--diagnostic-report-signal`
- `--diagnostic-report-uncaught-exception`
-- `--diagnostic-report-verbose`
- `--enable-fips`
- `--experimental-modules`
- `--experimental-repl-await`
diff --git a/doc/api/process.md b/doc/api/process.md
index b87223b9c4..1a009bce54 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -1703,8 +1703,6 @@ added: v11.8.0
* `filename` {string} Name of the file where the report is written.
* `path` {string} Directory where the report is written.
**Default:** the current working directory of the Node.js process.
- * `verbose` {boolean} Flag that controls additional verbose information on
- report generation. **Default:** `false`.
Configures the diagnostic reporting behavior. Upon invocation, the runtime
is reconfigured to generate reports based on `options`. Several usage examples
@@ -1721,9 +1719,6 @@ process.report.setOptions({ filename: 'foo.json', path: '/home' });
// to `stdout` and `stderr`. Usage of these will result in report being written
// to the associated standard streams. URLs are not supported.
process.report.setOptions({ filename: 'stdout' });
-
-// Enable verbose option on report generation.
-process.report.setOptions({ verbose: true });
```
Signal based report generation is not supported on Windows.
diff --git a/doc/api/report.md b/doc/api/report.md
index 8d6d054c0a..419fe33417 100644
--- a/doc/api/report.md
+++ b/doc/api/report.md
@@ -401,9 +401,6 @@ written.
* `--diagnostic-report-signal` Sets or resets the signal for report generation
(not supported on Windows). Default signal is `SIGUSR2`.
-* `--diagnostic-report-verbose` Flag that enables additional information to be
-printed during report generation.
-
A report can also be triggered via an API call from a JavaScript application:
```js
@@ -495,8 +492,7 @@ process.report.setOptions({
events: ['exception', 'fatalerror', 'signal'],
signal: 'SIGUSR2',
filename: 'myreport.json',
- path: '/home/nodeuser',
- verbose: true
+ path: '/home/nodeuser'
});
```
@@ -519,9 +515,6 @@ timestamp, PID and sequence number.
URLs are not supported. Defaults to the current working directory of the
Node.js process.
-`verbose` specifies whether to print additional verbose messages
-pertinent to the report generation. Defaults to `false`.
-
```js
// Trigger report only on uncaught exceptions.
process.report.setOptions({ events: ['exception'] });
@@ -541,7 +534,7 @@ environment variables:
NODE_OPTIONS="--experimental-report --diagnostic-report-uncaught-exception \
--diagnostic-report-on-fatalerror --diagnostic-report-on-signal \
--diagnostic-report-signal=SIGUSR2 --diagnostic-report-filename=./report.json \
- --diagnostic-report-directory=/home/nodeuser --diagnostic-report-verbose"
+ --diagnostic-report-directory=/home/nodeuser"
```
Specific API documentation can be found under
diff --git a/doc/node.1 b/doc/node.1
index 6a4a80b34e..c0bdeb1beb 100644
--- a/doc/node.1
+++ b/doc/node.1
@@ -114,11 +114,6 @@ to be generated on un-caught exceptions, if
.Sy --experimental-report
is enabled. Useful when inspecting JavaScript stack in conjunction with native stack and other runtime environment data.
.
-.It Fl -diagnostic-report-verbose
-Flag that enables additional information to be printed during
-.Sy diagnostic report
-generation.
-.
.It Fl -enable-fips
Enable FIPS-compliant crypto at startup.
Requires Node.js to be built with