From 8c800adab7ca441519e4bc503450123a80923c41 Mon Sep 17 00:00:00 2001 From: Andrew Gallant Date: Tue, 20 Feb 2018 19:39:16 -0500 Subject: doc: clarify failure mode This adds a hint for end users that run into a common failure mode where ripgrep won't search any files because they have a `*` rule in their `$HOME/.gitignore`. Fixes #815 --- GUIDE.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/GUIDE.md b/GUIDE.md index c1e58313..264d55a0 100644 --- a/GUIDE.md +++ b/GUIDE.md @@ -58,6 +58,10 @@ $ rg fast README.md 129: optimizations to make searching very fast. ``` +(**Note:** If you see an error message from ripgrep saying that it didn't +search any files, then re-run ripgrep with the `--debug` flag. One likely cause +of this is that you have a `*` rule in a `$HOME/.gitignore` file.) + So what happened here? ripgrep read the contents of `README.md`, and for each line that contained `fast`, ripgrep printed it to your terminal. ripgrep also included the line number for each line by default. If your terminal supports -- cgit v1.2.3