diff options
| author | Kyle Todeschini <dragonite44@gmail.com> | 2022-01-12 21:18:20 +1100 |
|---|---|---|
| committer | Andrew Gallant <jamslam@gmail.com> | 2023-07-08 18:52:42 -0400 |
| commit | 3b66f37a31d4fcc2aedc0737692c820d26452be4 (patch) | |
| tree | 4908dc13afb3bc2e015d906f9356aaa1e7171125 | |
| parent | 3eccb7c363d23d3b5e936721ed3e4358fe0acc7c (diff) | |
doc: improve -r/--replace flag syntax docs
Fixes #2108, Closes #2123
| -rw-r--r-- | CHANGELOG.md | 3 | ||||
| -rw-r--r-- | crates/core/app.rs | 11 |
2 files changed, 14 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index e67e6ac1..baa58b5c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,8 @@ Bug fixes: Fix bug when using `-w` with a regex that can match the empty string. * [BUG #1911](https://github.com/BurntSushi/ripgrep/issues/1911): Disable mmap searching in all non-64-bit environments. +* [BUG #2108](https://github.com/BurntSushi/ripgrep/issues/2108): + Improve docs for `-r/--replace` syntax. * [BUG #2198](https://github.com/BurntSushi/ripgrep/issues/2198): Fix bug where `--no-ignore-dot` would not ignore `.rgignore`. * [BUG #2288](https://github.com/BurntSushi/ripgrep/issues/2288): @@ -33,6 +35,7 @@ Bug fixes: * [BUG #2523](https://github.com/BurntSushi/ripgrep/issues/2523): Make executable searching take `.com` into account on Windows. + 13.0.0 (2021-06-12) =================== ripgrep 13 is a new major version release of ripgrep that primarily contains diff --git a/crates/core/app.rs b/crates/core/app.rs index fce7a2b4..d38bf986 100644 --- a/crates/core/app.rs +++ b/crates/core/app.rs @@ -2646,6 +2646,17 @@ replacement string. Capture group indices are numbered based on the position of the opening parenthesis of the group, where the leftmost such group is $1. The special $0 group corresponds to the entire match. +The name of a group is formed by taking the longest string of letters, numbers +and underscores (i.e. [_0-9A-Za-z]) after the $. For example, $1a will be +replaced with the group named '1a', not the group at index 1. If the group's +name contains characters that aren't letters, numbers or underscores, or you +want to immediately follow the group with another string, the name should be +put inside braces. For example, ${1}a will take the content of the group at +index 1 and append 'a' to the end of it. + +If an index or name does not refer to a valid capture group, it will be +replaced with an empty 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. |