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.

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

cli: add alias for report-directory to make it consistent #33587

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ Write reports in a compact format, single-line JSON, more easily consumable
by log processing systems than the default multi-line format designed for
human consumption.

### `--report-directory=directory`
### --report-dir=directory`, `report-directory=directory`
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: missing backtick.

<!-- YAML
added: v11.8.0
changes:
Expand Down Expand Up @@ -1245,7 +1245,7 @@ Node.js options that are allowed are:
* `--prof-process`
* `--redirect-warnings`
* `--report-compact`
* `--report-directory`
* `--report-dir`, `--report-directory`
* `--report-filename`
* `--report-on-fatalerror`
* `--report-on-signal`
Expand Down
2 changes: 1 addition & 1 deletion doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ Write
.Sy diagnostic reports
in a compact format, single-line JSON.
.
.It Fl -report-directory
.It Fl -report-dir Fl -report-directory
Location at which the
.Sy diagnostic report
will be generated.
Expand Down
5 changes: 3 additions & 2 deletions src/node_options.cc
Original file line number Diff line number Diff line change
Expand Up @@ -665,11 +665,12 @@ PerProcessOptionsParser::PerProcessOptionsParser(
"output compact single-line JSON",
&PerProcessOptions::report_compact,
kAllowedInEnvironment);
AddOption("--report-directory",
AddOption("--report-dir",
"define custom report pathname."
" (default: current working directory of Node.js process)",
" (default: current working directory)",
&PerProcessOptions::report_directory,
kAllowedInEnvironment);
AddAlias("--report-directory", "--report-dir");
AddOption("--report-filename",
"define custom report file name."
" (default: YYYYMMDD.HHMMSS.PID.SEQUENCE#.txt)",
Expand Down