0.1.8

We should probably still test on it, but I'd prefer distributing exactly
one Linux binary. Since the musl build is a totally static executable,
we should prefer that.

(The right answer is to test on GNU nightly, but don't produce a release
artifact.)

.travis.yml

@@ -15,9 +15,6 @@ matrix:
     - os: linux
       rust: nightly
       env: TARGET=x86_64-unknown-linux-musl
-    - os: linux
-      rust: nightly
-      env: TARGET=x86_64-unknown-linux-gnu
     - os: osx
       rust: nightly
       env: TARGET=i686-apple-darwin

Cargo.lock

@@ -1,11 +1,11 @@
 [root]
 name = "ripgrep"
-version = "0.1.3"
+version = "0.1.8"
 dependencies = [
  "deque 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)",
  "docopt 0.6.83 (registry+https://github.com/rust-lang/crates.io-index)",
  "env_logger 0.3.5 (registry+https://github.com/rust-lang/crates.io-index)",
- "fnv 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)",
+ "fnv 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)",
  "glob 0.2.11 (registry+https://github.com/rust-lang/crates.io-index)",
  "grep 0.1.1",
  "kernel32-sys 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -60,7 +60,7 @@ dependencies = [
 
 [[package]]
 name = "fnv"
-version = "1.0.4"
+version = "1.0.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 
 [[package]]
@@ -236,7 +236,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 "checksum deque 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)" = "1614659040e711785ed8ea24219140654da1729f3ec8a47a9719d041112fe7bf"
 "checksum docopt 0.6.83 (registry+https://github.com/rust-lang/crates.io-index)" = "fc42c6077823a361410c37d47c2535b73a190cbe10838dc4f400fe87c10c8c3b"
 "checksum env_logger 0.3.5 (registry+https://github.com/rust-lang/crates.io-index)" = "15abd780e45b3ea4f76b4e9a26ff4843258dd8a3eed2775a0e7368c2e7936c2f"
-"checksum fnv 1.0.4 (registry+https://github.com/rust-lang/crates.io-index)" = "8e8af7b5408ab0c4910cad114c8f9eb454bf75df7afe8964307eeafb68a13a5e"
+"checksum fnv 1.0.5 (registry+https://github.com/rust-lang/crates.io-index)" = "6cc484842f1e2884faf56f529f960cc12ad8c71ce96cc7abba0a067c98fee344"
 "checksum fs2 0.2.5 (registry+https://github.com/rust-lang/crates.io-index)" = "bcd414e5a1a979b931bb92f41b7a54106d3f6d2e6c253e9ce943b7cd468251ef"
 "checksum glob 0.2.11 (registry+https://github.com/rust-lang/crates.io-index)" = "8be18de09a56b60ed0edf84bc9df007e30040691af7acd1c41874faac5895bfb"
 "checksum kernel32-sys 0.2.2 (registry+https://github.com/rust-lang/crates.io-index)" = "7507624b29483431c0ba2d82aece8ca6cdba9382bff4ddd0f7490560c056098d"

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ripgrep"
-version = "0.1.3"  #:version
+version = "0.1.8"  #:version
 authors = ["Andrew Gallant <jamslam@gmail.com>"]
 description = """
 Line oriented search tool using Rust's regex library. Combines the raw

README-NEW.md

@@ -0,0 +1,238 @@
+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).
+
+[![Linux build status](https://api.travis-ci.org/BurntSushi/ripgrep.png)](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)
+[![](https://img.shields.io/crates/v/ripgrep.svg)](https://crates.io/crates/ripgrep)
+
+Dual-licensed under MIT or the [UNLICENSE](http://unlicense.org).
+
+### Screenshot of search results
+
+[![A screenshot of a sample search with ripgrep](http://burntsushi.net/stuff/ripgrep1.png)](http://burntsushi.net/stuff/ripgrep1.png)
+
+### Quick example comparing tools
+
+This example searches the entire Linux kernel source tree (after running
+`make defconfig && make -j8`) for `[A-Z]+_SUSPEND`, where all matches must be
+words. Timings were collected on a system with an Intel i7-6900K 3.2 GHz.
+
+Please remember that a single benchmark is never enough! See my
+[blog post on `ripgrep`](http://blog.burntsushi.net/ripgrep/)
+for a very detailed comparison with more benchmarks and analysis.
+
+| Tool | Command | Line count | Time |
+| ---- | ------- | ---------- | ---- |
+| ripgrep | `rg -n -w '[A-Z]+_SUSPEND'` | 450 | **0.245s** |
+| [The Silver Searcher](https://github.com/ggreer/the_silver_searcher) | `ag -w '[A-Z]+_SUSPEND'` | 450 | 0.753s |
+| [git grep](https://www.kernel.org/pub/software/scm/git/docs/git-grep.html) | `LC_ALL=C git grep -E -n -w '[A-Z]+_SUSPEND'` | 450 | 0.823s |
+| [git grep](https://www.kernel.org/pub/software/scm/git/docs/git-grep.html) | `LC_ALL=en_US.UTF-8 git grep -E -n -w '[A-Z]+_SUSPEND'` | 450 | 2.880s |
+| [sift](https://github.com/svent/sift) | `sift --git -n -w '[A-Z]+_SUSPEND'` | 450 | 3.656s |
+| [The Platinum Searcher](https://github.com/monochromegane/the_platinum_searcher) | `pt -w -e '[A-Z]+_SUSPEND'` | 450 | 12.369s |
+| [ack](http://beyondgrep.com/) | `ack -w '[A-Z]+_SUSPEND'` | 1878 | 16.952s |
+
+(Yes, `ack` [has](https://github.com/petdance/ack2/issues/445) a
+[bug](https://github.com/petdance/ack2/issues/14).)
+
+### Why should I use `ripgrep`?
+
+* It can replace both The Silver Searcher and GNU grep because it is faster
+  than both. (N.B. It is not, strictly speaking, a "drop-in" replacement for
+  both, but the feature sets are far more similar than different.)
+* Like The Silver Searcher, `ripgrep` defaults to recursive directory search
+  and won't search files ignored by your `.gitignore` files. It also ignores
+  hidden and binary files by default. `ripgrep` also implements full support
+  for `.gitignore`, where as there are many bugs related to that functionality
+  in The Silver Searcher.
+* `ripgrep` can search specific types of files. For example, `rg -tpy foo`
+  limits your search to Python files and `rg -Tjs foo` excludes Javascript
+  files from your search. `ripgrep` can be taught about new file types with
+  custom matching rules.
+* `ripgrep` supports many features found in `grep`, such as showing the context
+  of search results, searching multiple patterns, highlighting matches with
+  color and full Unicode support. Unlike GNU grep, `ripgrep` stays fast while
+  supporting Unicode (which is always on).
+
+### Is it really faster than everything else?
+
+Yes. A large number of benchmarks with detailed analysis for each is
+[available on my blog](http://blog.burntsushi.net/ripgrep/).
+
+Summarizing, `ripgrep` is fast because:
+
+* It is built on top of
+  [Rust's regex engine](https://github.com/rust-lang-nursery/regex).
+  Rust's regex engine uses finite automata, SIMD and aggressive literal
+  optimizations to make searching very fast.
+* Rust's regex library maintains performance with full Unicode support by
+  building UTF-8 decoding directly into its deterministic finite automaton
+  engine.
+* It supports searching with either memory maps or by searching incrementally
+  with an intermediate buffer. The former is better for single files and the
+  latter is better for large directories. `ripgrep` chooses the best searching
+  strategy for you automatically.
+* Applies your ignore patterns in `.gitignore` files using a
+  [`RegexSet`](https://doc.rust-lang.org/regex/regex/struct.RegexSet.html).
+  That means a single file path can be matched against multiple glob patterns
+  simultaneously.
+* Uses a Chase-Lev work-stealing queue for quickly distributing work to
+  multiple threads.
+
+### Installation
+
+N.B. `ripgrep` is not yet available in any package repositories. I'd like to
+fix that in the future.
+
+[Binaries for `ripgrep` are available for Windows, Mac and
+Linux.](https://github.com/BurntSushi/ripgrep/releases) Linux binaries are
+static executables. Windows binaries are available either as built with MinGW
+(GNU) or with Microsoft Visual C++ (MSVC). When possible, prefer MSVC over GNU,
+but you'll need to have the
+[Microsoft Visual C++ Build
+Tools](http://landinghub.visualstudio.com/visual-cpp-build-tools)
+installed.
+
+If you're a Rust programmer, `ripgrep` can be installed with `cargo`:
+
+```
+$ cargo install ripgrep
+```
+
+### Whirlwind tour
+
+The command line usage of `ripgrep` doesn't differ much from other tools that
+perform a similar function, so you probably already know how to use `ripgrep`.
+The full details can be found in `rg --help`, but let's go on a whirlwind tour.
+
+`ripgrep` detects when its printing to a terminal, and will automatically
+colorize your output and show line numbers, just like The Silver Searcher.
+Coloring works on Windows too! Colors can be controlled more granularly with
+the `--color` flag.
+
+One last thing before we get started: `ripgrep` assumes UTF-8 *everywhere*. It
+can still search files that are invalid UTF-8 (like, say, latin-1), but it will
+simply not work on UTF-16 encoded files or other more exotic encodings.
+[Support for other encodings may
+happen.](https://github.com/BurntSushi/ripgrep/issues/1)
+
+To recursively search the current directory, while respecting all `.gitignore`
+files, ignore hidden files and directories and skip binary files:
+
+```
+$ rg foobar
+```
+
+The above command also respects all `.rgignore` files, including in parent
+directories. `.rgignore` files can be used when `.gitignore` files are
+insufficient. In all cases, `.rgignore` patterns take precedence over
+`.gitignore`.
+
+To ignore all ignore files, use `-u`. To additionally search hidden files
+and directories, use `-uu`. To additionally search binary files, use `-uuu`.
+(In other words, "search everything, dammit!") In particular, `rg -uuu` is
+equivalent to `grep -a -r`.
+
+```
+$ rg -uu foobar  # equivalent to `grep -r`
+$ rg -uuu foobar  # equivalent to `grep -a -r`
+```
+
+(Tip: If your ignore files aren't being adhered to like you expect, run your
+search with the `--debug` flag.)
+
+Make the search case insensitive with `-i`, invert the search with `-v` or
+show the 2 lines before and after every search result with `-C2`.
+
+Force all matches to be surrounded by word boundaries with `-w`.
+
+Search and replace (find first and last names and swap them):
+
+```
+$ rg '([A-Z][a-z]+)\s+([A-Z][a-z]+)' --replace '$2, $1'
+```
+
+Named groups are supported:
+
+```
+$ rg '(?P<first>[A-Z][a-z]+)\s+(?P<last>[A-Z][a-z]+)' --replace '$last, $first'
+```
+
+Up the ante with full Unicode support, by matching any uppercase Unicode letter
+followed by any sequence of lowercase Unicode letters (good luck doing this
+with other search tools!):
+
+```
+$ rg '(\p{Lu}\p{Ll}+)\s+(\p{Lu}\p{Ll}+)' --replace '$2, $1'
+```
+
+Search only files matching a particular glob:
+
+```
+$ rg foo -g 'README.*'
+```
+
+<!--*-->
+
+Or exclude files matching a particular glob:
+
+```
+$ rg foo -g '!*.min.js'
+```
+
+Search only HTML and CSS files:
+
+```
+$ rg -thtml -tcss foobar
+```
+
+Search everything except for Javascript files:
+
+```
+$ rg -Tjs foobar
+```
+
+To see a list of types supported, run `rg --type-list`. To add a new type, use
+`--type-add`:
+
+```
+$ rg --type-add 'foo:*.foo,*.foobar'
+```
+
+The type `foo` will now match any file ending with the `.foo` or `.foobar`
+extensions.
+
+### Building
+
+`ripgrep` is written in Rust, so you'll need to grab a
+[Rust installation](https://www.rust-lang.org/) in order to compile it.
+`ripgrep` compiles with Rust 1.9 (stable) or newer. Building is easy:
+
+```
+$ git clone git://github.com/BurntSushi/ripgrep
+$ cd ripgrep
+$ cargo build --release
+$ ./target/release/rg --version
+0.1.3
+```
+
+If you have a Rust nightly compiler, then you can enable optional SIMD
+acceleration like so:
+
+```
+RUSTFLAGS="-C target-cpu=native" cargo build --release --features simd-accel
+```
+
+### Running tests
+
+`ripgrep` is relatively well tested, including both unit tests and integration
+tests. To run the full test suite, use:
+
+```
+$ cargo test
+```
+
+from the repository root.

benchsuite/benchsuite

@@ -132,6 +132,7 @@ def bench_linux_literal_casei(suite_dir):
         mkcmd('rg (ignore)', ['rg', '-n', '-i', pat]),
         mkcmd('rg (ignore) (mmap)', ['rg', '-n', '-i', '--mmap', pat]),
         mkcmd('ag (ignore) (mmap)', ['ag', '-i', pat]),
+        mkcmd('pt (ignore)', ['pt', '-i', pat]),
         mkcmd('sift (ignore)', SIFT + ['-n', '-i', '--git', pat]),
         # It'd technically be more appropriate to set LC_ALL=en_US.UTF-8 here,
         # since that is certainly what ripgrep is doing, but this is for an
@@ -165,6 +166,7 @@ def bench_linux_re_literal_suffix(suite_dir):
     return Benchmark(pattern=pat, commands=[
         mkcmd('rg (ignore)', ['rg', '-n', pat]),
         mkcmd('ag (ignore)', ['ag', '-s', pat]),
+        mkcmd('pt (ignore)', ['pt', '-e', pat]),
         mkcmd('sift (ignore)', SIFT + ['-n', '--git', pat]),
         mkcmd(
             'git grep (ignore)',
@@ -194,6 +196,7 @@ def bench_linux_word(suite_dir):
     return Benchmark(pattern=pat, commands=[
         mkcmd('rg (ignore)', ['rg', '-n', '-w', pat]),
         mkcmd('ag (ignore)', ['ag', '-s', '-w', pat]),
+        mkcmd('pt (ignore)', ['pt', '-w', pat]),
         mkcmd('sift (ignore)', SIFT + ['-n', '-w', '--git', pat]),
         mkcmd(
             'git grep (ignore)',
@@ -224,6 +227,7 @@ def bench_linux_unicode_greek(suite_dir):
 
     return Benchmark(pattern=pat, commands=[
         mkcmd('rg', ['rg', '-n', pat]),
+        mkcmd('pt', ['pt', '-e', pat]),
         mkcmd('sift', SIFT + ['-n', '--git', pat]),
     ])
 
@@ -244,6 +248,7 @@ def bench_linux_unicode_greek_casei(suite_dir):
 
     return Benchmark(pattern=pat, commands=[
         mkcmd('rg', ['rg', '-n', '-i', pat]),
+        mkcmd('pt', ['pt', '-i', '-e', pat]),
         mkcmd('sift', SIFT + ['-n', '-i', '--git', pat]),
     ])
 
@@ -268,7 +273,8 @@ def bench_linux_unicode_word(suite_dir):
         mkcmd('rg (ignore)', ['rg', '-n', pat]),
         mkcmd('rg (ignore) (ASCII)', ['rg', '-n', '(?-u)' + pat]),
         mkcmd('ag (ignore) (ASCII)', ['ag', '-s', pat]),
-        mkcmd('sift (ignore) (ASCII)', SIFT + ['-n', pat]),
+        mkcmd('pt (ignore) (ASCII)', ['pt', '-e', pat]),
+        mkcmd('sift (ignore) (ASCII)', SIFT + ['-n', '--git', pat]),
         mkcmd(
             'git grep (ignore)',
             ['git', 'grep', '-E', '-I', '-n', pat],
@@ -308,7 +314,8 @@ def bench_linux_no_literal(suite_dir):
         mkcmd('rg (ignore)', ['rg', '-n', pat]),
         mkcmd('rg (ignore) (ASCII)', ['rg', '-n', '(?-u)' + pat]),
         mkcmd('ag (ignore) (ASCII)', ['ag', '-s', pat]),
-        mkcmd('sift (ignore) (ASCII)', SIFT + ['-n', pat]),
+        mkcmd('pt (ignore) (ASCII)', ['pt', '-e', pat]),
+        mkcmd('sift (ignore) (ASCII)', SIFT + ['-n', '--git', pat]),
         mkcmd(
             'git grep (ignore)',
             ['git', 'grep', '-E', '-I', '-n', pat],
@@ -1125,7 +1132,8 @@ def download(suite_dir, choices):
 
 
 def collect_benchmarks(suite_dir, filter_pat=None,
-                       allow_missing_commands=False):
+                       allow_missing_commands=False,
+                       warmup_iter=1, bench_iter=3):
     '''
     Return an iterable of all runnable benchmarks.
 
@@ -1148,6 +1156,8 @@ def collect_benchmarks(suite_dir, filter_pat=None,
         try:
             benchmark = globals()[fun](suite_dir)
             benchmark.name = name
+            benchmark.warmup_count = warmup_iter
+            benchmark.count = bench_iter
             benchmark.allow_missing_commands = allow_missing_commands
             benchmark.raise_if_missing()
         except MissingDependencies as e:
@@ -1157,7 +1167,6 @@ def collect_benchmarks(suite_dir, filter_pat=None,
                     name,
                     ' '.join(['--download %s' % n for n in e.missing_names]),
                 ))
-            continue
         except MissingCommands as e:
             fmt = 'missing commands: %s, skipping benchmark %s ' \
                   '(run with --allow-missing to run incomplete benchmarks)'
@@ -1194,6 +1203,14 @@ def main():
         '--raw', metavar='PATH',
         help='Dump raw data (all samples collected) in CSV format to the '
              'file path provided.')
+    p.add_argument(
+        '--warmup-iter', metavar='INTEGER', type=int, default=1,
+        help='The number of iterations to run each command before '
+             'recording measurements.')
+    p.add_argument(
+        '--bench-iter', metavar='INTEGER', type=int, default=3,
+        help='The number of iterations to run each command while '
+             'recording measurements.')
     p.add_argument(
         'bench', metavar='PAT', nargs='?',
         help='A regex pattern that will only run benchmarks that match.')
@@ -1202,7 +1219,8 @@ def main():
     if args.list:
         benchmarks = collect_benchmarks(
             args.dir, filter_pat=args.bench,
-            allow_missing_commands=args.allow_missing)
+            allow_missing_commands=args.allow_missing,
+            warmup_iter=args.warmup_iter, bench_iter=args.bench_iter)
         for b in benchmarks:
             print(b.name)
         sys.exit(0)
@@ -1227,7 +1245,8 @@ def main():
 
     benchmarks = collect_benchmarks(
         args.dir, filter_pat=args.bench,
-        allow_missing_commands=args.allow_missing)
+        allow_missing_commands=args.allow_missing,
+        warmup_iter=args.warmup_iter, bench_iter=args.bench_iter)
     for i, b in enumerate(benchmarks):
         result = b.run()
         fastest_cmd = result.fastest_cmd()

benchsuite/runs/2016-09-20-ubuntu1604-ec2/README.SETUP

@@ -0,0 +1,93 @@
+Ubuntu 16.04 HVM AMI
+c3.2xlarge, Xeon E5-2680, 2.8 GHz, 8 CPUs, 16 GB memory, 80 GB SSD
+
+# Generic system setup
+
+mkfs.ext4 /dev/xvdb
+sudo mount /dev/xvdb /mnt
+sudo chown ubuntu /mnt
+sudo apt-get update
+sudo apt-get install \  # for building Linux kernel
+  make gcc bc
+sudo apt-get install \  # for the silver searcher
+  automake pkg-config zlib1g-dev liblzma-dev libpcre3 libpcre3-dev
+sudo apt-get install \  # for Universal Code Grep
+  libtool libpcre2-8-0 libpcre2-dev
+sudo apt-get install \  # for sift and the platinum searcher
+  go
+
+# Get benchmark corpora
+
+cd /mnt
+mkdir /mnt/bench
+git clone git://github.com/BurntSushi/ripgrep
+cd ripgrep/benchsuite
+./benchsuite --dir  /mnt/bench/ --download all  # takes around 15 minutes
+
+# Install search tools
+mkdir /mnt/bin/
+
+## ripgrep
+
+cd /mnt
+mkdir ripgrep-bin
+cd ripgrep-bin
+curl -LO 'https://github.com/BurntSushi/ripgrep/releases/download/0.1.2/ripgrep-0.1.2-x86_64-unknown-linux-musl.tar.gz'
+cp ripgrep-0.1.2-x86_64-unknown-linux-musl/rg /mnt/bin/
+
+## The Silver Searcher
+
+cd /mnt
+git clone git://github.com/ggreer/the_silver_searcher
+cd the_silver_searcher
+git checkout cda635
+./build.sh
+cp ag /mnt/bin/
+
+## Universal Code Grep
+
+cd /mnt
+git clone git://github.com/gvansickle/ucg
+cd ucg
+git checkout 487bfb
+autoreconf -i
+./configure
+make
+cp ucg /mnt/bin/
+
+## The Platinum Searcher
+
+export GOPATH=/mnt/go
+go get github.com/monochromegane/the_platinum_searcher
+cd /mnt/go/src/github.com/monochromegane/the_platinum_searcher
+git checkout 509368
+go install github.com/monochromegane/the_platinum_searcher/cmd/...
+cp /mnt/go/bin/pt /mnt/bin/
+
+## Sift
+
+export GOPATH=/mnt/go
+go get github.com/svent/sift
+cd /mnt/go/src/github.com/svent/sift
+git checkout 2d175c
+go install
+cp /mnt/go/bin/sift /mnt/bin/
+
+## 'git grep' and GNU grep
+
+They are part of the standard Ubuntu install, and are pretty recent (as of
+September 2016).
+
+$ git --version
+git version 2.7.4
+$ grep --version
+grep (GNU grep) 2.25
+
+
+# Running benchmarks
+
+export PATH="/mnt/bin:$PATH"
+cd /mnt/ripgrep/benchsuite
+./benchsuite \
+  --dir /mnt/bench/ --raw /mnt/bench/raw.csv --warmup-iter 3 --bench-iter 10
+# The above took around 120 minutes to run to completion.

benchsuite/runs/2016-09-20-ubuntu1604-ec2/summary

@@ -0,0 +1,233 @@
+linux_alternates (pattern: ERR_SYS|PME_TURN_OFF|LINK_REQ_RST|CFG_BME_EVT)
+-------------------------------------------------------------------------
+rg (ignore)         0.351 +/- 0.074 (lines: 68)
+ag (ignore)         1.747 +/- 0.005 (lines: 68)
+git grep (ignore)   0.501 +/- 0.003 (lines: 68)
+rg (whitelist)*     0.216 +/- 0.031 (lines: 68)
+ucg (whitelist)     0.214 +/- 0.008 (lines: 68)*
+
+linux_alternates_casei (pattern: ERR_SYS|PME_TURN_OFF|LINK_REQ_RST|CFG_BME_EVT)
+-------------------------------------------------------------------------------
+rg (ignore)         0.391 +/- 0.078 (lines: 160)
+ag (ignore)         1.968 +/- 0.009 (lines: 160)
+git grep (ignore)   2.018 +/- 0.006 (lines: 160)
+rg (whitelist)*     0.222 +/- 0.001 (lines: 160)*
+ucg (whitelist)     0.522 +/- 0.002 (lines: 160)
+
+linux_literal (pattern: PM_RESUME)
+----------------------------------
+rg (ignore)          0.334 +/- 0.053 (lines: 16)
+rg (ignore) (mmap)   1.611 +/- 0.009 (lines: 16)
+ag (ignore) (mmap)   1.588 +/- 0.011 (lines: 16)
+pt (ignore)          0.456 +/- 0.025 (lines: 16)
+sift (ignore)        0.630 +/- 0.004 (lines: 16)
+git grep (ignore)    0.345 +/- 0.007 (lines: 16)
+rg (whitelist)*      0.228 +/- 0.042 (lines: 16)
+ucg (whitelist)      0.218 +/- 0.007 (lines: 16)*
+
+linux_literal_casei (pattern: PM_RESUME)
+----------------------------------------
+rg (ignore)          0.345 +/- 0.073 (lines: 370)
+rg (ignore) (mmap)   1.612 +/- 0.011 (lines: 370)
+ag (ignore) (mmap)   1.609 +/- 0.015 (lines: 370)
+pt (ignore)          17.204 +/- 0.126 (lines: 370)
+sift (ignore)        0.805 +/- 0.005 (lines: 370)
+git grep (ignore)    0.343 +/- 0.007 (lines: 370)
+rg (whitelist)*      0.222 +/- 0.021 (lines: 370)
+ucg (whitelist)      0.217 +/- 0.006 (lines: 370)*
+
+linux_literal_default (pattern: PM_RESUME)
+------------------------------------------
+rg         0.349 +/- 0.104 (lines: 16)
+ag         1.589 +/- 0.009 (lines: 16)
+ucg*       0.218 +/- 0.007 (lines: 16)*
+pt         0.462 +/- 0.012 (lines: 16)
+sift       0.352 +/- 0.018 (lines: 16)
+git grep   0.342 +/- 0.005 (lines: 16)
+
+linux_no_literal (pattern: \w{5}\s+\w{5}\s+\w{5}\s+\w{5}\s+\w{5})
+-----------------------------------------------------------------
+rg (ignore)                 0.577 +/- 0.003 (lines: 490)
+rg (ignore) (ASCII)         0.416 +/- 0.025 (lines: 490)
+ag (ignore) (ASCII)         2.339 +/- 0.010 (lines: 766)
+pt (ignore) (ASCII)         22.066 +/- 0.057 (lines: 490)
+sift (ignore) (ASCII)       25.563 +/- 0.108 (lines: 490)
+git grep (ignore)           26.382 +/- 0.044 (lines: 490)
+git grep (ignore) (ASCII)   4.153 +/- 0.010 (lines: 490)
+rg (whitelist)              0.503 +/- 0.011 (lines: 419)
+rg (whitelist) (ASCII)*     0.343 +/- 0.038 (lines: 419)*
+ucg (whitelist) (ASCII)     1.130 +/- 0.003 (lines: 416)
+
+linux_re_literal_suffix (pattern: [A-Z]+_RESUME)
+------------------------------------------------
+rg (ignore)         0.318 +/- 0.034 (lines: 1652)
+ag (ignore)         1.899 +/- 0.008 (lines: 1652)
+pt (ignore)         13.713 +/- 0.241 (lines: 1652)
+sift (ignore)       10.172 +/- 0.186 (lines: 1652)
+git grep (ignore)   1.108 +/- 0.004 (lines: 1652)
+rg (whitelist)*     0.221 +/- 0.022 (lines: 1630)*
+ucg (whitelist)     0.301 +/- 0.001 (lines: 1630)
+
+linux_unicode_greek (pattern: \p{Greek})
+----------------------------------------
+rg*    0.414 +/- 0.021 (lines: 23)*
+pt     12.745 +/- 0.166 (lines: 23)
+sift   7.767 +/- 0.264 (lines: 23)
+
+linux_unicode_greek_casei (pattern: \p{Greek})
+----------------------------------------------
+rg     0.425 +/- 0.027 (lines: 103)
+pt     12.612 +/- 0.217 (lines: 23)
+sift*  0.002 +/- 0.000 (lines: 0)*
+
+linux_unicode_word (pattern: \wAh)
+----------------------------------
+rg (ignore)                 0.355 +/- 0.073 (lines: 186)
+rg (ignore) (ASCII)         0.329 +/- 0.060 (lines: 174)
+ag (ignore) (ASCII)         1.774 +/- 0.011 (lines: 174)
+pt (ignore) (ASCII)         14.180 +/- 0.180 (lines: 174)
+sift (ignore) (ASCII)       11.087 +/- 0.108 (lines: 174)
+git grep (ignore)           13.045 +/- 0.008 (lines: 186)
+git grep (ignore) (ASCII)   2.991 +/- 0.004 (lines: 174)
+rg (whitelist)              0.235 +/- 0.031 (lines: 180)
+rg (whitelist) (ASCII)*     0.225 +/- 0.023 (lines: 168)*
+ucg (ASCII)                 0.229 +/- 0.007 (lines: 168)
+
+linux_word (pattern: PM_RESUME)
+-------------------------------
+rg (ignore)         0.362 +/- 0.080 (lines: 6)
+ag (ignore)         1.603 +/- 0.009 (lines: 6)
+pt (ignore)         14.417 +/- 0.144 (lines: 6)
+sift (ignore)       7.840 +/- 0.123 (lines: 6)
+git grep (ignore)   0.341 +/- 0.005 (lines: 6)
+rg (whitelist)*     0.220 +/- 0.026 (lines: 6)*
+ucg (whitelist)     0.221 +/- 0.007 (lines: 6)
+
+subtitles_en_alternate (pattern: Sherlock Holmes|John Watson|Irene Adler|Inspector Lestrade|Professor Moriarty)
+---------------------------------------------------------------------------------------------------------------
+rg (lines)     0.619 +/- 0.001 (lines: 848)
+ag (lines)     3.757 +/- 0.001 (lines: 848)
+ucg (lines)    1.479 +/- 0.002 (lines: 848)
+grep (lines)   3.412 +/- 0.004 (lines: 848)
+rg*            0.294 +/- 0.001 (lines: 848)*
+grep           2.955 +/- 0.003 (lines: 848)
+
+subtitles_en_alternate_casei (pattern: Sherlock Holmes|John Watson|Irene Adler|Inspector Lestrade|Professor Moriarty)
+---------------------------------------------------------------------------------------------------------------------
+ag (ASCII)     5.170 +/- 0.004 (lines: 862)
+ucg (ASCII)    3.453 +/- 0.005 (lines: 862)
+grep (ASCII)   4.537 +/- 0.025 (lines: 862)
+rg*            2.724 +/- 0.002 (lines: 862)*
+grep           5.125 +/- 0.006 (lines: 862)
+
+subtitles_en_literal (pattern: Sherlock Holmes)
+-----------------------------------------------
+rg*            0.269 +/- 0.000 (lines: 629)*
+pt             3.436 +/- 0.001 (lines: 629)
+sift           0.327 +/- 0.002 (lines: 629)
+grep           0.517 +/- 0.001 (lines: 629)
+rg (lines)     0.596 +/- 0.001 (lines: 629)
+ag (lines)     2.730 +/- 0.003 (lines: 629)
+ucg (lines)    0.814 +/- 0.003 (lines: 629)
+pt (lines)     3.438 +/- 0.004 (lines: 629)
+sift (lines)   0.759 +/- 0.003 (lines: 629)
+grep (lines)   0.971 +/- 0.001 (lines: 629)
+
+subtitles_en_literal_casei (pattern: Sherlock Holmes)
+-----------------------------------------------------
+rg*                   0.366 +/- 0.001 (lines: 642)*
+grep                  4.084 +/- 0.005 (lines: 642)
+grep (ASCII)          0.614 +/- 0.001 (lines: 642)
+rg (lines)            0.696 +/- 0.002 (lines: 642)
+ag (lines) (ASCII)    2.775 +/- 0.004 (lines: 642)
+ucg (lines) (ASCII)   0.841 +/- 0.002 (lines: 642)
+
+subtitles_en_literal_word (pattern: Sherlock Holmes)
+----------------------------------------------------
+rg (ASCII)     0.596 +/- 0.001 (lines: 629)
+ag (ASCII)     2.729 +/- 0.001 (lines: 629)
+ucg (ASCII)    0.810 +/- 0.002 (lines: 629)
+grep (ASCII)   0.970 +/- 0.000 (lines: 629)
+rg*            0.596 +/- 0.001 (lines: 629)*
+grep           0.972 +/- 0.003 (lines: 629)
+
+subtitles_en_no_literal (pattern: \w{5}\s+\w{5}\s+\w{5}\s+\w{5}\s+\w{5}\s+\w{5}\s+\w{5})
+----------------------------------------------------------------------------------------
+rg             2.777 +/- 0.003 (lines: 13)
+rg (ASCII)*    2.541 +/- 0.005 (lines: 13)*
+ag (ASCII)     10.076 +/- 0.005 (lines: 48)
+ucg (ASCII)    7.771 +/- 0.004 (lines: 13)
+grep (ASCII)   4.411 +/- 0.004 (lines: 13)
+
+subtitles_en_surrounding_words (pattern: \w+\s+Holmes\s+\w+)
+------------------------------------------------------------
+rg             0.605 +/- 0.000 (lines: 317)
+grep           1.286 +/- 0.002 (lines: 317)
+rg (ASCII)*    0.602 +/- 0.000 (lines: 317)*
+ag (ASCII)     11.663 +/- 0.008 (lines: 323)
+ucg (ASCII)    4.690 +/- 0.002 (lines: 317)
+grep (ASCII)   1.276 +/- 0.002 (lines: 317)
+
+subtitles_ru_alternate (pattern: Шерлок Холмс|Джон Уотсон|Ирен Адлер|инспектор Лестрейд|профессор Мориарти)
+-----------------------------------------------------------------------------------------------------------
+rg (lines)     1.902 +/- 0.002 (lines: 691)
+ag (lines)     5.892 +/- 0.003 (lines: 691)
+ucg (lines)    2.864 +/- 0.006 (lines: 691)
+grep (lines)   8.511 +/- 0.005 (lines: 691)
+rg*            1.300 +/- 0.002 (lines: 691)*
+grep           7.994 +/- 0.017 (lines: 691)
+
+subtitles_ru_alternate_casei (pattern: Шерлок Холмс|Джон Уотсон|Ирен Адлер|инспектор Лестрейд|профессор Мориарти)
+-----------------------------------------------------------------------------------------------------------------
+ag (ASCII)     5.891 +/- 0.001 (lines: 691)
+ucg (ASCII)*   2.868 +/- 0.005 (lines: 691)*
+grep (ASCII)   8.572 +/- 0.009 (lines: 691)
+rg             4.834 +/- 0.004 (lines: 735)
+grep           8.729 +/- 0.004 (lines: 735)
+
+subtitles_ru_literal (pattern: Шерлок Холмс)
+--------------------------------------------
+rg*            0.326 +/- 0.001 (lines: 583)*
+pt             12.922 +/- 0.010 (lines: 583)
+sift           16.424 +/- 0.010 (lines: 583)
+grep           0.786 +/- 0.003 (lines: 583)
+rg (lines)     0.927 +/- 0.002 (lines: 583)
+ag (lines)     4.481 +/- 0.003 (lines: 583)
+ucg (lines)    1.897 +/- 0.009 (lines: 583)
+pt (lines)     12.937 +/- 0.006 (lines: 583)
+sift (lines)   17.178 +/- 0.008 (lines: 583)
+grep (lines)   1.301 +/- 0.005 (lines: 583)
+
+subtitles_ru_literal_casei (pattern: Шерлок Холмс)
+--------------------------------------------------
+rg                    1.131 +/- 0.001 (lines: 604)
+grep                  8.187 +/- 0.006 (lines: 604)
+grep (ASCII)          0.785 +/- 0.001 (lines: 583)
+rg (lines)            1.733 +/- 0.002 (lines: 604)
+ag (lines) (ASCII)*   0.729 +/- 0.001 (lines: 0)*
+ucg (lines) (ASCII)   1.896 +/- 0.005 (lines: 583)
+
+subtitles_ru_literal_word (pattern: Шерлок Холмс)
+-------------------------------------------------
+rg (ASCII)*    0.325 +/- 0.000 (lines: 0)*
+ag (ASCII)     0.753 +/- 0.001 (lines: 0)
+ucg (ASCII)    1.891 +/- 0.004 (lines: 583)
+grep (ASCII)   1.303 +/- 0.004 (lines: 583)
+rg             0.929 +/- 0.001 (lines: 579)
+grep           1.304 +/- 0.003 (lines: 579)
+
+subtitles_ru_no_literal (pattern: \w{5}\s+\w{5}\s+\w{5}\s+\w{5}\s+\w{5}\s+\w{5}\s+\w{5})
+----------------------------------------------------------------------------------------
+rg             4.905 +/- 0.003 (lines: 41)
+rg (ASCII)     3.973 +/- 0.002 (lines: 0)
+ag (ASCII)*    2.395 +/- 0.004 (lines: 0)*
+ucg (ASCII)    3.006 +/- 0.005 (lines: 0)
+grep (ASCII)   2.483 +/- 0.005 (lines: 0)
+
+subtitles_ru_surrounding_words (pattern: \w+\s+Холмс\s+\w+)
+-----------------------------------------------------------
+rg*            0.957 +/- 0.001 (lines: 278)*
+grep           1.660 +/- 0.002 (lines: 278)
+ag (ASCII)     2.411 +/- 0.001 (lines: 0)
+ucg (ASCII)    2.980 +/- 0.002 (lines: 0)
+grep (ASCII)   1.596 +/- 0.003 (lines: 0)

src/args.rs

@@ -74,6 +74,12 @@ Common options:
                                to list all available types.
     -T, --type-not TYPE ...    Do not search files matching TYPE. Multiple
                                not-type flags may be provided.
+    -u, --unrestricted ...     Reduce the level of 'smart' searching. A
+                               single -u doesn't respect .gitignore (etc.)
+                               files. Two -u flags will search hidden files
+                               and directories. Three -u flags will search
+                               binary files. -uu is equivalent to grep -r,
+                               and -uuu is equivalent to grep -a -r.
     -v, --invert-match         Invert matching.
     -w, --word-regexp          Only show matches surrounded by word boundaries.
                                This is equivalent to putting \\b before and
@@ -199,6 +205,7 @@ pub struct RawArgs {
     flag_type_list: bool,
     flag_type_add: Vec<String>,
     flag_type_clear: Vec<String>,
+    flag_unrestricted: u32,
     flag_with_filename: bool,
     flag_word_regexp: bool,
 }
@@ -312,6 +319,9 @@ impl RawArgs {
                 .line_terminator(eol)
                 .build()
         );
+        let no_ignore = self.flag_no_ignore || self.flag_unrestricted >= 1;
+        let hidden = self.flag_hidden || self.flag_unrestricted >= 2;
+        let text = self.flag_text || self.flag_unrestricted >= 3;
         let mut args = Args {
             pattern: pattern,
             paths: paths,
@@ -327,18 +337,18 @@ impl RawArgs {
             glob_overrides: glob_overrides,
             grep: grep,
             heading: !self.flag_no_heading && self.flag_heading,
-            hidden: self.flag_hidden,
+            hidden: hidden,
             ignore_case: self.flag_ignore_case,
             invert_match: self.flag_invert_match,
             line_number: !self.flag_no_line_number && self.flag_line_number,
             mmap: mmap,
-            no_ignore: self.flag_no_ignore,
+            no_ignore: no_ignore,
             no_ignore_parent:
                 // --no-ignore implies --no-ignore-parent
-                self.flag_no_ignore_parent || self.flag_no_ignore,
+                self.flag_no_ignore_parent || no_ignore,
             quiet: self.flag_quiet,
             replace: self.flag_replace.clone().map(|s| s.into_bytes()),
-            text: self.flag_text,
+            text: text,
             threads: threads,
             type_defs: btypes.definitions(),
             type_list: self.flag_type_list,

src/main.rs

@@ -118,15 +118,23 @@ fn run(args: Args) -> Result<u64> {
         }
         workq
     };
+    let mut paths_searched: u64 = 0;
     for p in paths {
         if p == Path::new("-") {
-            workq.push(Work::Stdin)
+            paths_searched += 1;
+            workq.push(Work::Stdin);
         } else {
             for ent in try!(args.walker(p)) {
+                paths_searched += 1;
                 workq.push(Work::File(ent));
             }
         }
     }
+    if !paths.is_empty() && paths_searched == 0 {
+        eprintln!("No files were searched, which means ripgrep probably \
+                   applied a filter you didn't expect. \
+                   Try running again with --debug.");
+    }
     for _ in 0..workers.len() {
         workq.push(Work::Quit);
     }

tests/tests.rs

@@ -525,6 +525,39 @@ baz/sherlock:be, to a very large extent, the result of luck. Sherlock Holmes
     }
 });
 
+sherlock!(unrestricted1, "Sherlock", ".", |wd: WorkDir, mut cmd: Command| {
+    wd.create(".gitignore", "sherlock\n");
+    cmd.arg("-u");
+
+    let lines: String = wd.stdout(&mut cmd);
+    let expected = "\
+sherlock:For the Doctor Watsons of this world, as opposed to the Sherlock
+sherlock:be, to a very large extent, the result of luck. Sherlock Holmes
+";
+    assert_eq!(lines, expected);
+});
+
+sherlock!(unrestricted2, "Sherlock", ".", |wd: WorkDir, mut cmd: Command| {
+    wd.remove("sherlock");
+    wd.create(".sherlock", hay::SHERLOCK);
+    cmd.arg("-uu");
+
+    let lines: String = wd.stdout(&mut cmd);
+    let expected = "\
+.sherlock:For the Doctor Watsons of this world, as opposed to the Sherlock
+.sherlock:be, to a very large extent, the result of luck. Sherlock Holmes
+";
+    assert_eq!(lines, expected);
+});
+
+sherlock!(unrestricted3, "foo", ".", |wd: WorkDir, mut cmd: Command| {
+    wd.create("file", "foo\x00bar\nfoo\x00baz\n");
+    cmd.arg("-uuu");
+
+    let lines: String = wd.stdout(&mut cmd);
+    assert_eq!(lines, "file:foo\nfile:foo\n");
+});
+
 #[test]
 fn binary_nosearch() {
     let wd = WorkDir::new("binary_nosearch");