summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortillyboy <31419678+tillyboy@users.noreply.github.com>2020-05-27 14:19:30 +0200
committerAndrew Gallant <jamslam@gmail.com>2021-05-31 21:51:18 -0400
commitc53c4c0ade23f639cd00c22b2e4fcba89f4f8039 (patch)
treeb8127784ad5865ce624d3f54400910d7adbf7f14
parent4566882521b880274c510ef65d58995d0b049b6a (diff)
doc: explain ignore rules a bit more
Closes #1600
-rw-r--r--GUIDE.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/GUIDE.md b/GUIDE.md
index 7ff81f99..3e5e399a 100644
--- a/GUIDE.md
+++ b/GUIDE.md
@@ -177,15 +177,19 @@ After recursive search, ripgrep's most important feature is what it *doesn't*
search. By default, when you search a directory, ripgrep will ignore all of
the following:
-1. Files and directories that match the rules in your `.gitignore` glob
- pattern.
+1. Files and directories that match glob patterns in these three categories:
+ 1. gitignore globs (including global and repo-specific globs).
+ 2. `.ignore` globs, which take precedence over all gitignore globs when
+ there's a conflict.
+ 3. `.rgignore` globs, which take precedence over all `.ignore` globs when
+ there's a conflict.
2. Hidden files and directories.
3. Binary files. (ripgrep considers any file with a `NUL` byte to be binary.)
4. Symbolic links aren't followed.
All of these things can be toggled using various flags provided by ripgrep:
-1. You can disable `.gitignore` handling with the `--no-ignore` flag.
+1. You can disable all ignore-related filtering with the `--no-ignore` flag.
2. Hidden files and directories can be searched with the `--hidden` flag.
3. Binary files can be searched via the `--text` (`-a` for short) flag.
Be careful with this flag! Binary files may emit control characters to your