From: Thomas Rast <trast@student.ethz.ch>
To: Jonathan Nieder <jrnieder@gmail.com>
Cc: <git@vger.kernel.org>, Johan Herland <johan@herland.net>,
Johannes Schindelin <Johannes.Schindelin@gmx.de>
Subject: Re: [PATCH 4/4] Documentation/notes: nitpicks
Date: Tue, 4 May 2010 09:09:42 +0200 [thread overview]
Message-ID: <201005040909.43247.trast@student.ethz.ch> (raw)
In-Reply-To: <20100503234720.GD27483@progeny.tock>
Jonathan Nieder wrote:
> -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).
Nitpick on your nitpick: we do not call refs/notes/commits the "main"
notes ref anywhere, and you don't seem to introduce this terminology.
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.
[I'll review the other patches after the lecture.]
--
Thomas Rast
trast@{inf,student}.ethz.ch
next prev parent reply other threads:[~2010-05-04 7:10 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-05-03 23:36 [PATCH 0/4] Documentation/notes: fill out the man page a little Jonathan Nieder
2010-05-03 23:41 ` [PATCH 1/4] Documentation/notes: describe effect of environment and configuration Jonathan Nieder
2010-05-04 9:24 ` Thomas Rast
2010-05-03 23:42 ` [PATCH 2/4] Documentation/notes: adjust description to use configuration section Jonathan Nieder
2010-05-03 23:42 ` [PATCH 3/4] Documentation/notes: describe content of notes Jonathan Nieder
2010-05-04 9:28 ` Thomas Rast
2010-05-04 9:55 ` Johan Herland
2010-05-05 3:23 ` Jeff King
2010-05-03 23:47 ` [PATCH 4/4] Documentation/notes: nitpicks Jonathan Nieder
2010-05-04 7:09 ` Thomas Rast [this message]
2010-05-04 7:23 ` 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=201005040909.43247.trast@student.ethz.ch \
--to=trast@student.ethz.ch \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=johan@herland.net \
--cc=jrnieder@gmail.com \
/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).