From 7bb9f35d2d0b02952e20c082b17be856788e5f44 Mon Sep 17 00:00:00 2001 From: Andrew Gallant Date: Sat, 25 Nov 2023 09:13:14 -0500 Subject: [PATCH] doc: clarify that --pre can accept any kind of path Fixes #2046 --- CHANGELOG.md | 2 ++ crates/core/flags/defs.rs | 6 +++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4a4225628..afdbab2c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -67,6 +67,8 @@ Bug fixes: Disable mmap searching in all non-64-bit environments. * [BUG #1966](https://github.com/BurntSushi/ripgrep/issues/1966): Fix bug where ripgrep can panic when printing to stderr. +* [BUG #2046](https://github.com/BurntSushi/ripgrep/issues/2046): + Clarify that `--pre` can accept any kind of path in the documentation. * [BUG #2108](https://github.com/BurntSushi/ripgrep/issues/2108): Improve docs for `-r/--replace` syntax. * [BUG #2198](https://github.com/BurntSushi/ripgrep/issues/2198): diff --git a/crates/core/flags/defs.rs b/crates/core/flags/defs.rs index dbb85779a..492e548cf 100644 --- a/crates/core/flags/defs.rs +++ b/crates/core/flags/defs.rs @@ -5359,9 +5359,9 @@ impl Flag for Pre { fn doc_long(&self) -> &'static str { r#" For each input \fIPATH\fP, this flag causes ripgrep to search the standard -output of \fICOMMAND\fP \fIPATH\fP instead of the contents of \fIPATH\fP. This -option expects the \fICOMMAND\fP program to either be an absolute path or to -be available in your \fBPATH\fP. Either an empty string \fICOMMAND\fP or the +output of \fICOMMAND\fP \fIPATH\fP instead of the contents of \fIPATH\fP. +This option expects the \fICOMMAND\fP program to either be a path or to be +available in your \fBPATH\fP. Either an empty string \fICOMMAND\fP or the \fB\-\-no\-pre\fP flag will disable this behavior. .sp .TP 12