Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: fix nits in report docs #26461

Closed
wants to merge 1 commit into from
Closed

doc: fix nits in report docs #26461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1669,7 +1669,7 @@ added: v11.8.0
reports for the current process. Additional documentation is available in the
[report documentation][].

## process.report.directory
### process.report.directory
<!-- YAML
added: REPLACEME
-->
Expand All @@ -1684,6 +1684,21 @@ Node.js process.
console.log(`Report directory is ${process.report.directory}`);
```

### process.report.filename
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sad thing is that I tried to put this in the right place but can't alphabet apparently. Sorry

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You've got too much on your plate to be sorry about missing nits))

<!-- YAML
added: REPLACEME
-->

* {string}

Filename where the report is written. If set to the empty string, the output
filename will be comprised of a timestamp, PID, and sequence number. The default
value is the empty string.

```js
console.log(`Report filename is ${process.report.filename}`);
```

### process.report.getReport([err])
<!-- YAML
added: v11.8.0
Expand All @@ -1702,22 +1717,7 @@ console.log(data);

Additional documentation is available in the [report documentation][].

## process.report.filename
<!-- YAML
added: REPLACEME
-->

* {string}

Filename where the report is written. If set to the empty string, the output
filename will be comprised of a timestamp, PID, and sequence number. The default
value is the empty string.

```js
console.log(`Report filename is ${process.report.filename}`);
```

## process.report.reportOnFatalError
### process.report.reportOnFatalError
<!-- YAML
added: REPLACEME
-->
Expand All @@ -1731,7 +1731,7 @@ memory errors or failed C++ assertions.
console.log(`Report on fatal error: ${process.report.reportOnFatalError}`);
```

## process.report.reportOnSignal
### process.report.reportOnSignal
<!-- YAML
added: REPLACEME
-->
Expand All @@ -1745,7 +1745,7 @@ signal specified by `process.report.signal`.
console.log(`Report on signal: ${process.report.reportOnSignal}`);
```

## process.report.reportOnUncaughtException
### process.report.reportOnUncaughtException
<!-- YAML
added: REPLACEME
-->
Expand All @@ -1758,15 +1758,15 @@ If `true`, a diagnostic report is generated on uncaught exception.
console.log(`Report on exception: ${process.report.reportOnUncaughtException}`);
```

## process.report.signal
### process.report.signal
<!-- YAML
added: REPLACEME
-->

* {string}

The signal used to trigger the creation of a diagnostic report. Defaults to
`SIGUSR2`.
`'SIGUSR2'`.

```js
console.log(`Report signal: ${process.report.signal}`);
Expand Down
4 changes: 2 additions & 2 deletions doc/api/report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,7 @@ to intercept external triggers for report generation. Defaults to
`filename` specifies the name of the output file in the file system.
Special meaning is attached to `stdout` and `stderr`. Usage of these
will result in report being written to the associated standard streams.
In cases where standard streams are used, the value in `'directory'` is ignored.
In cases where standard streams are used, the value in `directory` is ignored.
URLs are not supported. Defaults to a composite filename that contains
timestamp, PID and sequence number.

Expand All @@ -522,7 +522,7 @@ process.report.reportOnFatalError = true;
process.report.reportOnSignal = true;
process.report.reportOnUncaughtException = false;

// Change the default signal to `SIGQUIT` and enable it.
// Change the default signal to 'SIGQUIT' and enable it.
process.report.reportOnFatalError = false;
process.report.reportOnUncaughtException = false;
process.report.reportOnSignal = true;
Expand Down