[PATCH v2] update revisions doc for quoting in ':/' notation
From: ryenus <hidden>
Date: 2017-08-17 06:55:10
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
To make sure the `<text>` in `:/<text>` is seen as one search string, one should quote/escape `<text>` properly. Especially, the example given in the manual `:/fix nasty bug` does not work because of missing quotes when used in shell. A note about quoting/escaping is added along with a working example, however, the original example is left-as-is to be consistent with other examples. Signed-off-by: ryenus <redacted> --- Documentation/revisions.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 61277469c..d2862d55d 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt@@ -185,7 +185,9 @@ existing tag object. e.g. ':/^foo'. The special sequence ':/!' is reserved for modifiers to what is matched. ':/!-foo' performs a negative match, while ':/!!foo' matches a literal '!' character, followed by 'foo'. Any other sequence beginning with - ':/!' is reserved for now. + ':/!' is reserved for now. And make sure to quote/escape for the text to be + interpreted as the expected search string/pattern, e.g., for a commit whose + message matches a literal \'`$`', use `git show :/\\\$` or `git show ':/\$'`. '<rev>:<path>', e.g. 'HEAD:README', ':README', 'master:./README':: A suffix ':' followed by a path names the blob or tree
--
2.14.1