public inbox for git@vger.kernel.org 
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox•com>
To: "Keller\, Jacob E" <jacob.e.keller@intel•com>
Cc: "git\@vger.kernel.org" <git@vger•kernel.org>,
	"mh\@glandium.org" <mh@glandium•org>,
	"mhagger\@alum.mit.edu" <mhagger@alum•mit.edu>,
	"johan\@herland.net" <johan@herland•net>,
	"jacob.keller\@gmail.com" <jacob.keller@gmail•com>
Subject: Re: [PATCH] notes: document behavior of --ref and --notes DWIMery
Date: Tue, 22 Sep 2015 14:23:09 -0700	[thread overview]
Message-ID: <xmqqpp1a1742.fsf@gitster.mtv.corp.google.com> (raw)
In-Reply-To: <1442955811.26280.50.camel@intel.com> (Jacob E. Keller's message of "Tue, 22 Sep 2015 21:03:31 +0000")

"Keller, Jacob E" <jacob.e.keller@intel•com> writes:

> On Tue, 2015-09-22 at 13:40 -0700, Junio C Hamano wrote:
>> How about phrasing it totally differently?
>> 
>> 	The ref specifies the full refname when it begins with
>> 	`refs/notes/`; otherwise `ref/notes/` is prefixed to form a
>> 	full name of the ref.
>> 
>> I think that would remove the need to illustrate with concrete
>> examples like refs/heads/blah.
>> 
>
> Wait, what about the DWIM of notes/<name> goes to refs/notes/<name>..
> do we need to explain that here?

Yeah, throw that in, too.

	... when it begins with `refs/notes/`; when it begins with
	`notes/`, `refs/` and otherwise `refs/notes/` is prefixed to
	form a full name of the ref.

We could emphasize the end result by ending the sentence like so:

	... form a full name of the ref that is under `refs/notes/`.

if you wanted to.  I am neutral (I do not think it would hurt, but I
do not think it adds much clarity).

Thanks.

      reply	other threads:[~2015-09-22 21:23 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-09-22 20:24 [PATCH] notes: document behavior of --ref and --notes DWIMery Jacob Keller
2015-09-22 20:40 ` Junio C Hamano
2015-09-22 21:02   ` Keller, Jacob E
2015-09-22 21:03   ` Keller, Jacob E
2015-09-22 21:23     ` Junio C Hamano [this message]

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=xmqqpp1a1742.fsf@gitster.mtv.corp.google.com \
    --to=gitster@pobox$(echo .)com \
    --cc=git@vger$(echo .)kernel.org \
    --cc=jacob.e.keller@intel$(echo .)com \
    --cc=jacob.keller@gmail$(echo .)com \
    --cc=johan@herland$(echo .)net \
    --cc=mh@glandium$(echo .)org \
    --cc=mhagger@alum$(echo .)mit.edu \
    /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