git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: "brian m. carlson" <sandals@crustytoothpaste.net>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH] Documentation: fix missing text for rev-parse --verify
Date: Mon, 21 Jul 2014 16:14:38 -0700	[thread overview]
Message-ID: <20140721231438.GZ12427@google.com> (raw)
In-Reply-To: <1405983635-77468-1-git-send-email-sandals@crustytoothpaste.net>

brian m. carlson wrote:

> The caret (^) is used as a markup symbol in AsciiDoc.  Due to the
> inability of AsciiDoc to parse a line containing an unmatched caret, it
> omitted the line from the output, resulting in the man page missing the
> end of a sentence.

Wow.  Usually asciidoc is more forgiving than that.  Are there other
pages affected by this too (e.g., "the commit HEAD^" in
user-manual.txt)?

[...]
> --- 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 "\^{type}" peeling operator to the parameter.

Does using {caret} for ^ work, too?  Generally in asciidoc using a
backslash to escape delimiter characters leads to trouble when the
number of delimiters changes or the text is copy+pasted, since in a
context where the backslash is unneeded it ends up being rendered as a
literal backslash.

Alternatively, does "`^{type}`" work?

Thanks,
Jonathan

  reply	other threads:[~2014-07-21 23:14 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-21 23:00 [PATCH] Documentation: fix missing text for rev-parse --verify brian m. carlson
2014-07-21 23:14 ` Jonathan Nieder [this message]
2014-07-21 23:35   ` brian m. carlson
2014-07-22 23:38     ` [PATCH v2] " brian m. carlson
2014-07-22 23:41       ` Jonathan Nieder

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=20140721231438.GZ12427@google.com \
    --to=jrnieder@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=sandals@crustytoothpaste.net \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).