summaryrefslogtreecommitdiffstats
path: root/crates
diff options
context:
space:
mode:
authorDan Bjorge <dan@dbjorge.net>2021-04-15 19:21:26 -0400
committerGitHub <noreply@github.com>2021-04-15 19:21:26 -0400
commit92286ad4d2a9c8b054de8aaea05c23a7220d20b3 (patch)
tree9497ebdf20a015ae74770f1ff835fbba0eb46bf6 /crates
parent4ebe8375ec69769674a1c2270f2ec32eee1a944c (diff)
doc: clarify --hidden definition
On Windows, we didn't previously document that ripgrep respected both the prefix-dot convention _and_ the "hidden" attribute on files. Fixes #1847
Diffstat (limited to 'crates')
-rw-r--r--crates/core/app.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/crates/core/app.rs b/crates/core/app.rs
index c97578a3..e2688ceb 100644
--- a/crates/core/app.rs
+++ b/crates/core/app.rs
@@ -1433,6 +1433,10 @@ Search hidden files and directories. By default, hidden files and directories
are skipped. Note that if a hidden file or a directory is whitelisted in an
ignore file, then it will be searched even if this flag isn't provided.
+A file or directory is considered hidden if its base name starts with a dot
+character ('.'). On operating systems which support a `hidden` file attribute,
+like Windows, files with this attribute are also considered hidden.
+
This flag can be disabled with --no-hidden.
"
);
@@ -1971,6 +1975,9 @@ fn flag_no_ignore_dot(args: &mut Vec<RGArg>) {
"\
Don't respect .ignore files.
+This does *not* affect whether ripgrep will ignore files and directories
+whose names begin with a dot. For that, see --hidden.
+
This flag can be disabled with the --ignore-dot flag.
"
);