twin/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-05-18 17:20:21 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc: add docs about .ignore/.rgignore in parent directories

Browse Source 
Closes #2479
This commit is contained in:
Andrew Gallant 2023-11-21 20:18:22 -05:00
parent b7df9f8caa
commit 58e7d2ea63
4 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -75,6 +75,8 @@ Bug fixes:
Make `-p/--pretty` override flags like `--no-line-number`. Make `-p/--pretty` override flags like `--no-line-number`.
* [BUG #2392](https://github.com/BurntSushi/ripgrep/issues/2392): * [BUG #2392](https://github.com/BurntSushi/ripgrep/issues/2392):
Improve global git config parsing of the `excludesFile` field. Improve global git config parsing of the `excludesFile` field.
* [BUG #2479](https://github.com/BurntSushi/ripgrep/issues/2479):
Add documentation about `.ignore`/`.rgignore` files in parent directories.
* [BUG #2480](https://github.com/BurntSushi/ripgrep/issues/2480): * [BUG #2480](https://github.com/BurntSushi/ripgrep/issues/2480):
Fix bug when using inline regex flags with `-e/--regexp`. Fix bug when using inline regex flags with `-e/--regexp`.
* [BUG #2519](https://github.com/BurntSushi/ripgrep/issues/2519): * [BUG #2519](https://github.com/BurntSushi/ripgrep/issues/2519):

10
GUIDE.md
View File

@ -178,11 +178,15 @@ search. By default, when you search a directory, ripgrep will ignore all of
the following: the following:
1. Files and directories that match glob patterns in these three categories: 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 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 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. 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.

2
crates/core/flags/defs.rs
View File

@ -4734,7 +4734,7 @@ impl Flag for NoRequireGit {
fn doc_long(&self) -> &'static str { fn doc_long(&self) -> &'static str {
r" r"
When this flag is given, source control ignore files such as \fB.gitignore\fP When this flag is given, source control ignore files such as \fB.gitignore\fP
are respect even if no \fBgit\fP repository is present. are respected even if no \fBgit\fP repository is present.
.sp .sp
By default, ripgrep will only respect filter rules from source control ignore By default, ripgrep will only respect filter rules from source control ignore
files when ripgrep detects that the search is executed inside a source control files when ripgrep detects that the search is executed inside a source control

10
crates/core/flags/doc/template.rg.1
View File

@ -165,7 +165,9 @@ this includes the following:
Any global rules, e.g., in \fB$HOME/.config/git/ignore\fP. Any global rules, e.g., in \fB$HOME/.config/git/ignore\fP.
. .
.IP \(bu 3n .IP \(bu 3n
Any rules in relevant \fB.gitignore\fP files. Any rules in relevant \fB.gitignore\fP files. This includes \fB.gitignore\fP
files in parent directories that are part of the same \fBgit\fP repository.
(Unless \fB\-\-no\-require\-git\fP is given.)
. .
.IP \(bu 3n .IP \(bu 3n
Any local rules, e.g., in \fB.git/info/exclude\fP. Any local rules, e.g., in \fB.git/info/exclude\fP.
@ -180,10 +182,12 @@ precisely, or otherwise use \fBgit grep\fP for search.
Additional ignore rules can be provided outside of a \fBgit\fP context: Additional ignore rules can be provided outside of a \fBgit\fP context:
. .
.IP \(bu 3n .IP \(bu 3n
Any rules in \fB.ignore\fP. Any rules in \fB.ignore\fP. ripgrep will also respect \fB.ignore\fP files in
parent directories.
. .
.IP \(bu 3n .IP \(bu 3n
Any rules in \fB.rgignore\fP. Any rules in \fB.rgignore\fP. ripgrep will also respect \fB.rgignore\fP files
in parent directories.
. .
.IP \(bu 3n .IP \(bu 3n
Any rules in files specified with the \fB\-\-ignore\-file\fP flag. Any rules in files specified with the \fB\-\-ignore\-file\fP flag.