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

doc: clarify that .git is covered by --hidden and not --ignore-vcs

Browse Source 
Fixes #3121, Closes #3122
This commit is contained in:
Lucas Garron
2025-08-07 18:39:34 -07:00
committed by Andrew Gallant
parent 2d5fb3a995
commit 1ef939442f
1 changed files with 14 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -2752,6 +2752,11 @@ ripgrep.
A file or directory is considered hidden if its base name starts with a dot A file or directory is considered hidden if its base name starts with a dot
character (\fB.\fP). On operating systems which support a "hidden" file character (\fB.\fP). On operating systems which support a "hidden" file
attribute, like Windows, files with this attribute are also considered hidden. attribute, like Windows, files with this attribute are also considered hidden.
.sp
Note that \flag{hidden} will include files and folders like \fB.git\fP
regardless of \flag{no-ignore-vcs}. To exclude such paths when using
\flag{hidden}, you must explicitly ignore them using another flag or ignore
file.
"# "#
} }
@@ -4603,11 +4608,15 @@ impl Flag for NoIgnoreVcs {
} }
fn doc_long(&self) -> &'static str { fn doc_long(&self) -> &'static str {
r" r"
When given, filter rules from source control ignore files (e.g., \fB.gitignore\fP) When given, filter rules from source control ignore files (e.g.,
are not respected. By default, ripgrep respects \fBgit\fP's ignore rules for \fB.gitignore\fP) are not respected. By default, ripgrep respects \fBgit\fP's
automatic filtering. In some cases, it may not be desirable to respect the ignore rules for automatic filtering. In some cases, it may not be desirable
source control's ignore rules and instead only respect rules in \fB.ignore\fP to respect the source control's ignore rules and instead only respect rules in
or \fB.rgignore\fP. \fB.ignore\fP or \fB.rgignore\fP.
.sp
Note that this flag does not directly affect the filtering of source control
files or folders that start with a dot (\fB.\fP), like \fB.git\fP. These are
affected by \flag{hidden} and its related flags instead.
.sp .sp
This flag implies \flag{no-ignore-parent} for source control ignore files as This flag implies \flag{no-ignore-parent} for source control ignore files as
well. well.