summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2018-07-21 17:50:54 -0400
committerAndrew Gallant <jamslam@gmail.com>2018-07-21 17:50:54 -0400
commitc96a3585935f8fb064fd40828447ba862f86ff5b (patch)
tree37aee9d29955acb1efb48085261ee6640bba33a2
parent231456c409ff38c75c39d01b781b569965ddf808 (diff)
ripgrep: add warning to --pre flag
The --pre flag can result in a pretty large performance penalty, so put a warning in the flag documentation. This warning is important because a flag like this could easily wind up in a user's configuration file.
-rw-r--r--src/app.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/app.rs b/src/app.rs
index 67b7295e..6344f530 100644
--- a/src/app.rs
+++ b/src/app.rs
@@ -1473,6 +1473,10 @@ contents of FILE. This option expects the COMMAND program to either be an
absolute path or to be available in your PATH. An empty string COMMAND
deactivates this feature.
+WARNING: When this flag is set, ripgrep will unconditionally spawn a process
+for every file that is searched. Therefore, this can incur a large performance
+penalty if you don't otherwise need the flexibility offered by this flag.
+
A preprocessor is not run when ripgrep is searching stdin.
When searching over sets of files that may require one of several decoders