summaryrefslogtreecommitdiffstats
path: root/crates
diff options
context:
space:
mode:
authorAndrew Gallant <jamslam@gmail.com>2023-11-21 20:18:22 -0500
committerAndrew Gallant <jamslam@gmail.com>2023-11-25 15:03:53 -0500
commit58e7d2ea6375860fa09a043d6a1ba20518dfb462 (patch)
tree308857265badc26bdb30c426dcffed7874845aa3 /crates
parentb7df9f8caa842b4904aa086b52485e63758621e6 (diff)
doc: add docs about .ignore/.rgignore in parent directories
Closes #2479
Diffstat (limited to 'crates')
-rw-r--r--crates/core/flags/defs.rs2
-rw-r--r--crates/core/flags/doc/template.rg.110
2 files changed, 8 insertions, 4 deletions
diff --git a/crates/core/flags/defs.rs b/crates/core/flags/defs.rs
index ed78c28a..38611759 100644
--- a/crates/core/flags/defs.rs
+++ b/crates/core/flags/defs.rs
@@ -4734,7 +4734,7 @@ impl Flag for NoRequireGit {
fn doc_long(&self) -> &'static str {
r"
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
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
diff --git a/crates/core/flags/doc/template.rg.1 b/crates/core/flags/doc/template.rg.1
index 5c7fbdb8..6c3359d6 100644
--- a/crates/core/flags/doc/template.rg.1
+++ b/crates/core/flags/doc/template.rg.1
@@ -165,7 +165,9 @@ this includes the following:
Any global rules, e.g., in \fB$HOME/.config/git/ignore\fP.
.
.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
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:
.
.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
-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
Any rules in files specified with the \fB\-\-ignore\-file\fP flag.