From: Jeff King <peff@peff•net>
To: Jonh Wendell <jonh.wendell@gmail•com>
Cc: git@vger•kernel.org, Junio C Hamano <gitster@pobox•com>
Subject: Re: [PATCH 2/2] describe: Add documentation for "--abbrev=+"
Date: Sun, 14 Sep 2014 04:23:02 -0400 [thread overview]
Message-ID: <20140914082302.GB20526@peff.net> (raw)
In-Reply-To: <1410532004-22769-3-git-send-email-jonh.wendell@gmail.com>
On Fri, Sep 12, 2014 at 11:26:44AM -0300, Jonh Wendell wrote:
> --- a/Documentation/git-describe.txt
> +++ b/Documentation/git-describe.txt
> @@ -54,6 +54,12 @@ OPTIONS
> abbreviated object name, use <n> digits, or as many digits
> as needed to form a unique object name. An <n> of 0
> will suppress long format, only showing the closest tag.
> + +
> + +
Why two continuation lines here? One seems to be enough on my version of
asciidoc (though it would not be the first time we have encountered
weird behaviors in our documentation toolchain).
> + A special case of <n> equals to "\+" (without quotes) will print
> + just a "+" sign instead of the whole suffix. This is useful if you
> + only need to know if the supplied <commit-ish> points to an exact
> + match or if there are commits between the tag found and the <commit-ish>.
I found this first phrase a little hard to parse. What about just:
An <n> of `+` will print...
That uses the same wording as above, and I think using backticks is
probably the right thing. It will appear in a monospaced font, which
avoids the need to explain the quotes (and you also do not need to
backslash-escape inside it).
-Peff
next prev parent reply other threads:[~2014-09-14 8:23 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-09-12 14:26 [PATCH 0/2] describe: support the syntax "--abbrev=+" Jonh Wendell
2014-09-12 14:26 ` [PATCH 1/2] " Jonh Wendell
2014-09-14 8:18 ` Jeff King
2014-09-14 8:56 ` Eric Sunshine
2014-09-12 14:26 ` [PATCH 2/2] describe: Add documentation for "--abbrev=+" Jonh Wendell
2014-09-14 8:23 ` Jeff King [this message]
-- strict thread matches above, loose matches on Subject: below --
2014-08-23 17:13 [PATCH 0/2] describe: support the syntax "--abbrev=+" Jonh Wendell
2014-08-23 17:13 ` [PATCH 2/2] describe: Add documentation for "--abbrev=+" Jonh Wendell
2014-08-24 6:35 ` brian m. carlson
2014-08-24 12:11 ` Jonh Wendell
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=20140914082302.GB20526@peff.net \
--to=peff@peff$(echo .)net \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
--cc=jonh.wendell@gmail$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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