doc: note that ripgrep may terminate unexpectedly

Fixes #581
2017-08-23 19:14:27 -04:00
parent 01358a155c
commit 398326bfe2
3 changed files with 27 additions and 1 deletions
--- a/src/app.rs
+++ b/src/app.rs
@@ -9,6 +9,10 @@ ripgrep's regex engine uses finite automata and guarantees linear time
 searching. Because of this, features like backreferences and arbitrary
 lookaround are not supported.

+Note that ripgrep may abort unexpectedly when using default settings if it
+searches a file that is simultaneously truncated. This behavior can be avoided
+by passing the --no-mmap flag.
+
 Project home page: https://github.com/BurntSushi/ripgrep

 Use -h for short descriptions and --help for more details.";