From dab205748dde60c0e3a895ee864fd06c79f66fba Mon Sep 17 00:00:00 2001
From: Chengzhong Wu <chengzhong.wcz@alibaba-inc.com>
Date: Fri, 19 Aug 2022 12:42:29 +0800
Subject: [PATCH] doc,report: document special filenames

Filenames `stdout` and `stderr` have special meanings when writing
the report.

PR-URL: https://github.com/nodejs/node/pull/44257
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Erick Wendel <erick.workspace@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
---
 doc/api/cli.md     | 3 +++
 doc/api/process.md | 6 ++++++
 2 files changed, 9 insertions(+)

diff --git a/doc/api/cli.md b/doc/api/cli.md
index 96527710c85cb4..232f8fd77394e8 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -1072,6 +1072,9 @@ changes:
 
 Name of the file to which the report will be written.
 
+If the filename is set to `'stdout'` or `'stderr'`, the report is written to
+the stdout or stderr of the process respectively.
+
 ### `--report-on-fatalerror`
 
 <!-- YAML
diff --git a/doc/api/process.md b/doc/api/process.md
index b38ef46189f72e..730f3f6ac9359e 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -2825,6 +2825,9 @@ 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.
 
+If the value of `process.report.filename` is set to `'stdout'` or `'stderr'`,
+the report is written to the stdout or stderr of the process respectively.
+
 ```mjs
 import { report } from 'node:process';
 
@@ -3020,6 +3023,9 @@ Writes a diagnostic report to a file. If `filename` is not provided, the default
 filename includes the date, time, PID, and a sequence number. The report's
 JavaScript stack trace is taken from `err`, if present.
 
+If the value of `filename` is set to `'stdout'` or `'stderr'`, the report is
+written to the stdout or stderr of the process respectively.
+
 ```mjs
 import { report } from 'node:process';