diff options
author | Andrew Gallant <jamslam@gmail.com> | 2023-11-21 20:18:22 -0500 |
---|---|---|
committer | Andrew Gallant <jamslam@gmail.com> | 2023-11-25 15:03:53 -0500 |
commit | 58e7d2ea6375860fa09a043d6a1ba20518dfb462 (patch) | |
tree | 308857265badc26bdb30c426dcffed7874845aa3 /GUIDE.md | |
parent | b7df9f8caa842b4904aa086b52485e63758621e6 (diff) |
doc: add docs about .ignore/.rgignore in parent directories
Closes #2479
Diffstat (limited to 'GUIDE.md')
-rw-r--r-- | GUIDE.md | 14 |
1 files changed, 9 insertions, 5 deletions
@@ -178,11 +178,15 @@ search. By default, when you search a directory, ripgrep will ignore all of the following: 1. Files and directories that match glob patterns in these three categories: - 1. gitignore globs (including global and repo-specific globs). + 1. `.gitignore` globs (including global and repo-specific globs). This + includes `.gitignore` files in parent directories that are part of the + same `git` repository. (Unless the `--no-require-git` flag is given.) 2. `.ignore` globs, which take precedence over all gitignore globs - when there's a conflict. + when there's a conflict. This includes `.ignore` files in parent + directories. 3. `.rgignore` globs, which take precedence over all `.ignore` globs - when there's a conflict. + when there's a conflict. This includes `.rgignore` files in parent + directories. 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. @@ -190,7 +194,7 @@ the following: All of these things can be toggled using various flags provided by ripgrep: 1. You can disable all ignore-related filtering with the `--no-ignore` flag. -2. Hidden files and directories can be searched with the `--hidden` (`-.` for +2. Hidden files and directories can be searched with the `--hidden` (`-.` 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 @@ -997,7 +1001,7 @@ used options that will likely impact how you use ripgrep on a regular basis. if the pattern contains any uppercase letters. Usually this flag is put into alias or a config file. * `-F/--fixed-strings`: Disable regular expression matching and treat the pattern - as a literal string. + as a literal string. * `-w/--word-regexp`: Require that all matches of the pattern be surrounded by word boundaries. That is, given `pattern`, the `--word-regexp` flag will cause ripgrep to behave as if `pattern` were actually `\b(?:pattern)\b`. |