summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2015-05-13 04:58:06 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-05-13 05:13:40 (GMT)
commitb50bfb8fd5357ec7902ff2f4a4fead9dc907f788 (patch)
tree5bd97463cddcc32b50f29701fc78579609b9647a
parente08bc7a9ec2c6988d90b603792760a3add11b9a0 (diff)
downloadgit-b50bfb8fd5357ec7902ff2f4a4fead9dc907f788.zip
git-b50bfb8fd5357ec7902ff2f4a4fead9dc907f788.tar.gz
git-b50bfb8fd5357ec7902ff2f4a4fead9dc907f788.tar.bz2
doc: fix unquoted use of "{type}"
Curly braces open an "attribute" in AsciiDoc; if there's no such attribute, strange things may happen. In this case, the unquoted "{type}" causes AsciiDoc to omit an entire line of text from the output. We can fix it by putting the whole phrase inside literal backticks (which also lets us get rid of ugly backslash escaping). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-rev-parse.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index d6de42f..11e032e 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -102,7 +102,7 @@ eval "set -- $(git rev-parse --sq --prefix "$prefix" "$@")"
+
If you want to make sure that the output actually names an object in
your object database and/or can be used as a specific type of object
-you require, you can add "\^{type}" peeling operator to the parameter.
+you require, you can add the `^{type}` peeling operator to the parameter.
For example, `git rev-parse "$VAR^{commit}"` will make sure `$VAR`
names an existing object that is a commit-ish (i.e. a commit, or an
annotated tag that points at a commit). To make sure that `$VAR`