From 8396d3ffaae3784880a6cef25775ba2abd9f4fcf Mon Sep 17 00:00:00 2001 From: Andrew Gallant Date: Mon, 12 Dec 2016 07:03:37 -0500 Subject: [PATCH] Make backreference support clear. Fixes #268. --- README.md | 14 ++++++++++---- doc/rg.1 | 5 +++++ doc/rg.1.md | 4 ++++ src/app.rs | 4 ++++ 4 files changed, 23 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 47df6151..dee58f98 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,15 @@ ripgrep (rg) ------------ -`ripgrep` is a command line search tool that combines the usability of The -Silver Searcher (an `ack` clone) with the raw speed of GNU grep. `ripgrep` has -first class support on Windows, Mac and Linux, with binary downloads available -for [every release](https://github.com/BurntSushi/ripgrep/releases). +`ripgrep` is a line oriented search tool that combines the usability of The +Silver Searcher (an `ack` clone) with the raw speed of GNU grep. `ripgrep` +works by recursively searching your current directory for a regex pattern. +`ripgrep` has first class support on Windows, Mac and Linux, with binary +downloads available for +[every release](https://github.com/BurntSushi/ripgrep/releases). + +ripgrep's regex engine uses finite automata and guarantees linear time +searching. Because of this, features like backreferences and arbitrary +lookaround are not supported. [![Linux build status](https://travis-ci.org/BurntSushi/ripgrep.svg?branch=master)](https://travis-ci.org/BurntSushi/ripgrep) [![Windows build status](https://ci.appveyor.com/api/projects/status/github/BurntSushi/ripgrep?svg=true)](https://ci.appveyor.com/project/BurntSushi/ripgrep) diff --git a/doc/rg.1 b/doc/rg.1 index d1f2174f..b6ea695c 100644 --- a/doc/rg.1 +++ b/doc/rg.1 @@ -24,6 +24,11 @@ rg [\f[I]options\f[]] \-\-version ripgrep (rg) combines the usability of The Silver Searcher (an ack clone) with the raw speed of grep. .PP +ripgrep\[aq]s regex engine uses finite automata and guarantees linear +time searching. +Because of this, features like backreferences and arbitrary lookaround +are not supported. +.PP Project home page: https://github.com/BurntSushi/ripgrep .SH COMMON OPTIONS .TP diff --git a/doc/rg.1.md b/doc/rg.1.md index f0fed3da..466a3539 100644 --- a/doc/rg.1.md +++ b/doc/rg.1.md @@ -21,6 +21,10 @@ rg [*options*] --version ripgrep (rg) combines the usability of The Silver Searcher (an ack clone) with the raw speed of grep. +ripgrep's regex engine uses finite automata and guarantees linear time +searching. Because of this, features like backreferences and arbitrary +lookaround are not supported. + Project home page: https://github.com/BurntSushi/ripgrep # COMMON OPTIONS diff --git a/src/app.rs b/src/app.rs index fe80a069..13b1ac60 100644 --- a/src/app.rs +++ b/src/app.rs @@ -5,6 +5,10 @@ use clap::{App, AppSettings, Arg, ArgSettings}; const ABOUT: &'static str = " ripgrep (rg) recursively searches your current directory for a regex pattern. +ripgrep's regex engine uses finite automata and guarantees linear time +searching. Because of this, features like backreferences and arbitrary +lookaround are not supported. + Project home page: https://github.com/BurntSushi/ripgrep Use -h for short descriptions and --help for more details.";