All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: Jean-Noel Avila <jn.avila@free.fr>, git@vger.kernel.org
Subject: [PATCH 2/8] doc: fix unquoted use of "{type}"
Date: Wed, 13 May 2015 00:58:06 -0400	[thread overview]
Message-ID: <20150513045805.GB6821@peff.net> (raw)
In-Reply-To: <20150513045650.GA6070@peff.net>

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>
---
 Documentation/git-rev-parse.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 97fc703..52e6826 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`
-- 
2.4.0.192.g5f8138b

  parent reply	other threads:[~2015-05-13  4:58 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-05-12 17:23 [PATCH] doc: fix unmatched code fences Jean-Noel Avila
2015-05-12 18:45 ` Junio C Hamano
2015-05-13  2:15   ` Jeff King
2015-05-13  3:43     ` Junio C Hamano
2015-05-13  3:45       ` Jeff King
2015-05-13  4:32         ` Junio C Hamano
2015-05-13  4:36           ` Jeff King
2015-05-13 22:22             ` brian m. carlson
2015-05-13  4:56     ` [PATCH 0/8] asciidoc fixups Jeff King
2015-05-13  4:57       ` [PATCH 1/8] doc: fix misrendering due to `single quote' Jeff King
2015-05-13  4:58       ` Jeff King [this message]
2015-05-13  4:58       ` [PATCH 3/8] doc: fix hanging "+"-continuation Jeff King
2015-05-13  4:58       ` [PATCH 4/8] doc: fix length of underlined section-title Jeff King
2015-05-13  4:58       ` [PATCH 5/8] doc/add: reformat `--edit` option Jeff King
2015-05-13  5:01       ` [PATCH 6/8] doc: convert \--option to --option Jeff King
2015-05-13  9:48         ` John Keeping
2015-05-14  4:32           ` Jeff King
2015-05-17 18:34             ` Junio C Hamano
2015-05-13  5:02       ` [PATCH 7/8] doc: drop backslash quoting of some curly braces Jeff King
2015-05-13  5:06       ` [PATCH 8/8] doc: put example URLs and emails inside literal backticks Jeff King
2015-05-13  5:09       ` [PATCH 0/8] asciidoc fixups Jeff King
2015-05-13  5:23       ` Junio C Hamano
2015-05-13  5:37         ` Jeff King
2015-05-13  7:43           ` Johannes Schindelin
2015-05-14  4:29             ` Jeff King
2015-05-13 22:41       ` brian m. carlson
2015-05-14  4:25         ` Jeff King
2015-05-14  4:34           ` [PATCH 9/8] doc: convert AsciiDoc {?foo} to ifdef::foo[] Jeff King
2015-05-14  7:43           ` [PATCH 0/8] asciidoc fixups Johannes Schindelin
2015-05-14 17:38             ` Jeff King
2015-05-14 18:20               ` Johannes Schindelin
2015-05-14 21:10                 ` Junio C Hamano
2015-05-14 21:17                   ` Jeff King
2015-05-14 21:40                     ` Junio C Hamano
2015-05-14 21:56                       ` David Turner
2015-05-15  2:52           ` brian m. carlson
2015-05-15  4:01             ` Jeff King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20150513045805.GB6821@peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jn.avila@free.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.