Skip to content

Commit

Permalink
cli: add alias for report-directory to make it consistent
Browse files Browse the repository at this point in the history
Currently every other cli option uses "dir" to reference a directory
so add an alias to allow for conistency.

PR-URL: nodejs#33587
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information
AshCripps authored and BridgeAR committed May 30, 2020
1 parent 5e77c67 commit 697bcd9
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
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`
<!-- 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 @@ -294,7 +294,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 @@ -664,11 +664,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

0 comments on commit 697bcd9

Please sign in to comment.