summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordana <dana@dana.is>2017-12-18 15:04:56 -0600
committerAndrew Gallant <jamslam@gmail.com>2017-12-18 17:58:26 -0500
commit162e085b98f8f2c627a92402d2e38dda04fc3e48 (patch)
treea024222de7367bc2b708ca5048a98297bdea9ccc /doc
parent86c890bcecf885619565ce949ddb9099d55dd43c (diff)
Add note about --smart-case smartness
Diffstat (limited to 'doc')
-rw-r--r--doc/rg.13
-rw-r--r--doc/rg.1.md4
2 files changed, 6 insertions, 1 deletions
diff --git a/doc/rg.1 b/doc/rg.1
index 9841c270..2ed14b39 100644
--- a/doc/rg.1
+++ b/doc/rg.1
@@ -457,6 +457,9 @@ Overrides \-\-ignore\-case and \-\-smart\-case.
Search case insensitively if the pattern is all lowercase.
Search case sensitively otherwise.
This is overridden by either \-\-case\-sensitive or \-\-ignore\-case.
+Note: This feature is smart enough to treat simple classes like \\S as
+lowercase, but may not handle more complex syntax like \\p{Ll} as
+expected.
.RS
.RE
.TP
diff --git a/doc/rg.1.md b/doc/rg.1.md
index 8009f69d..36c912c6 100644
--- a/doc/rg.1.md
+++ b/doc/rg.1.md
@@ -300,7 +300,9 @@ Project home page: https://github.com/BurntSushi/ripgrep
-S, --smart-case
: Search case insensitively if the pattern is all lowercase.
Search case sensitively otherwise. This is overridden by either
- --case-sensitive or --ignore-case.
+ --case-sensitive or --ignore-case. Note: This feature is smart enough
+ to treat simple classes like \\S as lowercase, but may not handle more
+ complex syntax like \\p{Ll} as expected.
--sort-files
: Sort results by file path. Note that this currently