diff options
| author | Andrew Gallant <jamslam@gmail.com> | 2019-01-26 14:36:34 -0500 |
|---|---|---|
| committer | Andrew Gallant <jamslam@gmail.com> | 2019-01-26 14:39:40 -0500 |
| commit | 31d3e241306f305c1cb94e1882511da2b48dcd36 (patch) | |
| tree | 9e7ca2b52a93780a20585356ce6cac98ac8db1c2 /doc | |
| parent | bf842dbc7fba45befe9b0d9e28f94336c809c9e3 (diff) | |
args: prevent panicking in 'rg -h | rg'
Previously, we relied on clap to handle printing either an error
message, or --help/--version output, in addition to setting the exit
status code. Unfortunately, for --help/--version output, clap was
panicking if the write failed, which can happen in fairly common
scenarios via a broken pipe error. e.g., `rg -h | head`.
We fix this by using clap's "safe" API and doing the printing ourselves.
We also set the exit code to `2` when an invalid command has been given.
Fixes #1125 and partially addresses #1159
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rg.1.txt.tpl | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/rg.1.txt.tpl b/doc/rg.1.txt.tpl index 9988edc9..c9a08f97 100644 --- a/doc/rg.1.txt.tpl +++ b/doc/rg.1.txt.tpl @@ -89,7 +89,8 @@ cases, the flag specified last takes precedence. EXIT STATUS ----------- If ripgrep finds a match, then the exit status of the program is 0. If no match -could be found, then the exit status is non-zero. +could be found, then the exit status is 1. If an error occurred, then the exit +status is 2. CONFIGURATION FILES |