summaryrefslogtreecommitdiffstats
path: root/GUIDE.md
diff options
context:
space:
mode:
authorDavid Torosyan <davidtorosyan.git@gmail.com>2019-01-20 17:32:34 -0800
committerAndrew Gallant <jamslam@gmail.com>2019-01-22 20:03:59 -0500
commit718a00f6f2f88238546f7d33c1ea52217002495e (patch)
tree6dc4db1c1d1af1f5d87957754341b4f74ff41984 /GUIDE.md
parent7cbc535d70a53c81dfa3e58552c01f21c2e38d28 (diff)
ripgrep: add --ignore-file-case-insensitive
The --ignore-file-case-insensitive flag causes all .gitignore/.rgignore/.ignore files to have their globs matched without regard for case. Because this introduces a potentially significant performance regression, this is always disabled by default. Users that need case insensitive matching can enable it on a case by case basis. Closes #1164, Closes #1170
Diffstat (limited to 'GUIDE.md')
-rw-r--r--GUIDE.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/GUIDE.md b/GUIDE.md
index ffcbff9f..8523b6a5 100644
--- a/GUIDE.md
+++ b/GUIDE.md
@@ -235,6 +235,11 @@ Like `.gitignore`, a `.ignore` file can be placed in any directory. Its rules
will be processed with respect to the directory it resides in, just like
`.gitignore`.
+To process `.gitignore` and `.ignore` files case insensitively, use the flag
+`--ignore-file-case-insensitive`. This is especially useful on case insensitive
+file systems like those on Windows and macOS. Note though that this can come
+with a significant performance penalty, and is therefore disabled by default.
+
For a more in depth description of how glob patterns in a `.gitignore` file
are interpreted, please see `man gitignore`.