Re: [PATCH 4/4] Documentation/notes: nitpicks

From: Jonathan Nieder <jrnieder@gmail.com>
Date: May 4, 2010, 07:23 UTC
Message-ID: <20100504072317.GA8410@progeny.tock>
In-Reply-To: <201005040909.43247.trast@student.ethz.ch>

Thomas Rast wrote:

> Jonathan Nieder wrote:

Show 10 quoted lines

>> -A typical use of notes is to extend a commit message without having
>> -to change the commit itself. Such commit notes can be shown by `git log`
>> -along with the original commit message. To discern these notes from the
>> +A typical use of notes is to supplement a commit message without
>> +changing the commit itself. Notes can be shown by 'git log' along with
>> +the original commit message. To distinguish these notes from the
>>  message stored in the commit object, the notes are indented like the
>>  message, after an unindented line saying "Notes (<refname>):" (or
>> -"Notes:" for the default setting).
>> +"Notes:" for the main notes ref).

[...]

> The user might infer that "main" means core.notesRef, but the omission
> of (<refname>) is actually hardcoded to only happen for
> refs/notes/commits, so that's not correct.

Oh!  I had no inkling.

I guess the simplest way to document this is to just say it:

	           ... unindented line saying "Notes (<refname>):' (or
	"Notes:" for refs/notes/commits).

Thanks for the explanation.

Cheers, Jonathan