Skip to content

Commit

Permalink
doc: clarify capture group indices
Browse files Browse the repository at this point in the history
And in particular, note the special $0 index, which corresponds to the
entire match.

Fixes #1591
  • Loading branch information
BurntSushi committed May 22, 2020
1 parent b72ad8f commit a700b75
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Bug fixes:

* [BUG #1581](https://github.com/BurntSushi/ripgrep/issues/1581):
Corrects some egregious markup output in `--help`.
* [BUG #1591](https://github.com/BurntSushi/ripgrep/issues/1591):
Mention the special `$0` capture group in docs for the `-r/--replace` flag.


12.1.0 (2020-05-09)
Expand Down
11 changes: 7 additions & 4 deletions crates/core/app.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2576,10 +2576,13 @@ Replace every match with the text given when printing results. Neither this
flag nor any other ripgrep flag will modify your files.
Capture group indices (e.g., $5) and names (e.g., $foo) are supported in the
replacement string. In shells such as Bash and zsh, you should wrap the
pattern in single quotes instead of double quotes. Otherwise, capture group
indices will be replaced by expanded shell variables which will most likely
be empty.
replacement string. Capture group indices are numbered based on the position of
the opening paranthesis of the group, where the leftmost such group is $1. The
special $0 group corresponds to the entire match.
In shells such as Bash and zsh, you should wrap the pattern in single quotes
instead of double quotes. Otherwise, capture group indices will be replaced by
expanded shell variables which will most likely be empty.
To write a literal '$', use '$$'.
Expand Down

0 comments on commit a700b75

Please sign in to comment.