doc: note how to escape a '$' in --replace

Fixes #1524
BurntSushi · May 9, 2020 · 50840ea · 50840ea
1 parent 17dcc2b
commit 50840ea
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@ TBD
 ===
 Bug fixes:
 
+* [BUG #1524](https://github.com/BurntSushi/ripgrep/issues/1524):
+  Note how to escape a `$` when using `--replace`.
 * [BUG #1537](https://github.com/BurntSushi/ripgrep/issues/1537):
   Fix match bug caused by inner literal optimization.
 * [BUG #1571](https://github.com/BurntSushi/ripgrep/issues/1571):

diff --git a/crates/core/app.rs b/crates/core/app.rs
@@ -2598,6 +2598,8 @@ 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 '$$'.
+
 Note that the replacement by default replaces each match, and NOT the entire
 line. To replace the entire line, you should match the entire line.