mirror of
https://github.com/BurntSushi/ripgrep.git
synced 2025-05-19 09:40:22 -07:00
doc: clarify and fix typo
Clarify that --byte-offset may be wrong if the source isn't being read directly. Also tweak the README a bit. And remove a damned Oxford comma.
This commit is contained in:
parent
87b745454d
commit
8f978a3cf7
2
FAQ.md
2
FAQ.md
@ -635,7 +635,7 @@ real 0m1.714s
|
|||||||
user 0m1.669s
|
user 0m1.669s
|
||||||
sys 0m0.044s
|
sys 0m0.044s
|
||||||
|
|
||||||
[andrew@Cheetah 2016] time rg -P '^\w{42}$' subtitles2016-sample --no-pcre2-unicode
|
$ time rg -P '^\w{42}$' subtitles2016-sample --no-pcre2-unicode
|
||||||
21225780:EverymajordevelopmentinthehistoryofAmerica
|
21225780:EverymajordevelopmentinthehistoryofAmerica
|
||||||
|
|
||||||
real 0m1.997s
|
real 0m1.997s
|
||||||
|
10
README.md
10
README.md
@ -23,7 +23,7 @@ Please see the [CHANGELOG](CHANGELOG.md) for a release history.
|
|||||||
* [Installation](#installation)
|
* [Installation](#installation)
|
||||||
* [User Guide](GUIDE.md)
|
* [User Guide](GUIDE.md)
|
||||||
* [Frequently Asked Questions](FAQ.md)
|
* [Frequently Asked Questions](FAQ.md)
|
||||||
* [Regex syntax](https://docs.rs/regex/0.2.5/regex/#syntax)
|
* [Regex syntax](https://docs.rs/regex/1/regex/#syntax)
|
||||||
* [Configuration files](GUIDE.md#configuration-file)
|
* [Configuration files](GUIDE.md#configuration-file)
|
||||||
* [Shell completions](FAQ.md#complete)
|
* [Shell completions](FAQ.md#complete)
|
||||||
* [Building](#building)
|
* [Building](#building)
|
||||||
@ -103,6 +103,10 @@ increases the times to `2.640s` for ripgrep and `10.277s` for GNU grep.
|
|||||||
of search results, searching multiple patterns, highlighting matches with
|
of search results, searching multiple patterns, highlighting matches with
|
||||||
color and full Unicode support. Unlike GNU grep, ripgrep stays fast while
|
color and full Unicode support. Unlike GNU grep, ripgrep stays fast while
|
||||||
supporting Unicode (which is always on).
|
supporting Unicode (which is always on).
|
||||||
|
* ripgrep has optional support for switching its regex engine to use PCRE2.
|
||||||
|
Among other things, this makes it possible to use look-around and
|
||||||
|
backreferences in your patterns, which are supported in ripgrep's default
|
||||||
|
regex engine. PCRE2 support is enabled with `-P`.
|
||||||
* ripgrep supports searching files in text encodings other than UTF-8, such
|
* ripgrep supports searching files in text encodings other than UTF-8, such
|
||||||
as UTF-16, latin-1, GBK, EUC-JP, Shift_JIS and more. (Some support for
|
as UTF-16, latin-1, GBK, EUC-JP, Shift_JIS and more. (Some support for
|
||||||
automatically detecting UTF-16 is provided. Other text encodings must be
|
automatically detecting UTF-16 is provided. Other text encodings must be
|
||||||
@ -114,7 +118,7 @@ increases the times to `2.640s` for ripgrep and `10.277s` for GNU grep.
|
|||||||
detection and so on.
|
detection and so on.
|
||||||
|
|
||||||
In other words, use ripgrep if you like speed, filtering by default, fewer
|
In other words, use ripgrep if you like speed, filtering by default, fewer
|
||||||
bugs, and Unicode support.
|
bugs and Unicode support.
|
||||||
|
|
||||||
|
|
||||||
### Why shouldn't I use ripgrep?
|
### Why shouldn't I use ripgrep?
|
||||||
@ -159,7 +163,7 @@ Summarizing, ripgrep is fast because:
|
|||||||
latter is better for large directories. ripgrep chooses the best searching
|
latter is better for large directories. ripgrep chooses the best searching
|
||||||
strategy for you automatically.
|
strategy for you automatically.
|
||||||
* Applies your ignore patterns in `.gitignore` files using a
|
* Applies your ignore patterns in `.gitignore` files using a
|
||||||
[`RegexSet`](https://docs.rs/regex/1.0.0/regex/struct.RegexSet.html).
|
[`RegexSet`](https://docs.rs/regex/1/regex/struct.RegexSet.html).
|
||||||
That means a single file path can be matched against multiple glob patterns
|
That means a single file path can be matched against multiple glob patterns
|
||||||
simultaneously.
|
simultaneously.
|
||||||
* It uses a lock-free parallel recursive directory iterator, courtesy of
|
* It uses a lock-free parallel recursive directory iterator, courtesy of
|
||||||
|
12
src/app.rs
12
src/app.rs
@ -685,9 +685,15 @@ fn flag_byte_offset(args: &mut Vec<RGArg>) {
|
|||||||
const SHORT: &str =
|
const SHORT: &str =
|
||||||
"Print the 0-based byte offset for each matching line.";
|
"Print the 0-based byte offset for each matching line.";
|
||||||
const LONG: &str = long!("\
|
const LONG: &str = long!("\
|
||||||
Print the 0-based byte offset within the input file
|
Print the 0-based byte offset within the input file before each line of output.
|
||||||
before each line of output. If -o (--only-matching) is
|
If -o (--only-matching) is specified, print the offset of the matching part
|
||||||
specified, print the offset of the matching part itself.
|
itself.
|
||||||
|
|
||||||
|
If ripgrep does transcoding, then the byte offset is in terms of the the result
|
||||||
|
of transcoding and not the original data. This applies similarly to another
|
||||||
|
transformation on the source, such as decompression or a --pre filter. Note
|
||||||
|
that when the PCRE2 regex engine is used, then UTF-8 transcoding is done by
|
||||||
|
default.
|
||||||
");
|
");
|
||||||
let arg = RGArg::switch("byte-offset").short("b")
|
let arg = RGArg::switch("byte-offset").short("b")
|
||||||
.help(SHORT).long_help(LONG);
|
.help(SHORT).long_help(LONG);
|
||||||
|
Loading…
x
Reference in New Issue
Block a user