twin/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-08-11 10:11:58 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc: explain ignore rules a bit more

Browse Source 
Closes #1600
This commit is contained in:
tillyboy
2020-05-27 14:19:30 +02:00
committed by Andrew Gallant
parent 4566882521
commit c53c4c0ade
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
GUIDE.md
View File

@@ -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 search. By default, when you search a directory, ripgrep will ignore all of
the following: the following:
1. Files and directories that match the rules in your `.gitignore` glob 1. Files and directories that match glob patterns in these three categories:
pattern. 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. 2. Hidden files and directories.
3. Binary files. (ripgrep considers any file with a `NUL` byte to be binary.) 3. Binary files. (ripgrep considers any file with a `NUL` byte to be binary.)
4. Symbolic links aren't followed. 4. Symbolic links aren't followed.
All of these things can be toggled using various flags provided by ripgrep: 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. 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. 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 Be careful with this flag! Binary files may emit control characters to your