From 6a055d922cb0899efe48d76defad3ff56ab7395d Mon Sep 17 00:00:00 2001 From: Andrew Gallant Date: Sat, 25 Nov 2023 14:18:24 -0500 Subject: [PATCH] doc: clarify errors for -z/--search-zip Fixes #1622 --- CHANGELOG.md | 2 ++ crates/core/flags/defs.rs | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1431b9509..3f45509c9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -63,6 +63,8 @@ Bug fixes: Don't error when `-v/--invert-match` is used multiple times. * [BUG #1275](https://github.com/BurntSushi/ripgrep/issues/1275): Fix bug with `\b` assertion in the regex engine. +* [BUG #1622](https://github.com/BurntSushi/ripgrep/issues/1622): + Add note about error messages to `-z/--search-zip` documentation. * [BUG #1648](https://github.com/BurntSushi/ripgrep/issues/1648): Fix bug where sometimes short flags with values, e.g., `-M 900`, would fail. * [BUG #1701](https://github.com/BurntSushi/ripgrep/issues/1701): diff --git a/crates/core/flags/defs.rs b/crates/core/flags/defs.rs index 5e76e4552..9200c1437 100644 --- a/crates/core/flags/defs.rs +++ b/crates/core/flags/defs.rs @@ -5969,7 +5969,9 @@ impl Flag for SearchZip { This flag instructs ripgrep to search in compressed files. Currently gzip, bzip2, xz, LZ4, LZMA, Brotli and Zstd files are supported. This option expects the decompression binaries (such as \fBgzip\fP) to be available in your -\fBPATH\fP. +\fBPATH\fP. If the required binaries are not found, then ripgrep will not +emit an error messages by default. Use the \flag{debug} flag to see more +information. .sp Note that this flag does not make ripgrep search archive formats as directory trees. It only makes ripgrep detect compressed files and then decompress them