git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: git@vger.kernel.org
Cc: Thomas Rast <trast@student.ethz.ch>,
	Johan Herland <johan@herland.net>,
	Johannes Schindelin <Johannes.Schindelin@gmx.de>
Subject: [PATCH 4/4] Documentation/notes: nitpicks
Date: Mon, 3 May 2010 18:47:20 -0500	[thread overview]
Message-ID: <20100503234720.GD27483@progeny.tock> (raw)
In-Reply-To: <20100503233604.GA27451@progeny.tock>

Spell out “or” in the NAME line and simplify the leading sentence
in the DESCRIPTION.

Some other language cleanups, too.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
That’s the end of the series.  Nothing dramatic, but I thought this
basic information could help.  Thanks for looking it over.

While I have your attention: the original man page said

  To disable commit notes, you have to set the config variable
  core.notesRef to the empty string.  Alternatively, you can set it
  to a different ref, something like "refs/notes/bugzilla".  This setting
  can be overridden by the environment variable "GIT_NOTES_REF".

which sounds helpful to me, both as an example and as a way to help
people who do not want to use the feature.  Any idea where we could
add it back?

 Documentation/git-notes.txt |   16 ++++++++--------
 1 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 273264b..b953575 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -3,7 +3,7 @@ git-notes(1)
 
 NAME
 ----
-git-notes - Add/inspect object notes
+git-notes - Add or inspect object notes
 
 SYNOPSIS
 --------
@@ -20,8 +20,8 @@ SYNOPSIS
 
 DESCRIPTION
 -----------
-This command allows you to add/remove notes to/from objects, without
-changing the objects themselves.
+Adds, removes, or reads notes attached to objects, without touching
+the objects themselves.
 
 By default, notes are saved to and read from `refs/notes/commits`, but
 this default can be overridden.  See the CONFIGURATION and ENVIRONMENT
@@ -31,14 +31,14 @@ Notes can contain any sequence of non-null bytes.  Since they are
 sanitized with linkgit:git-stripspace[1], empty lines other than a
 single line separating paragraphs are not significant.
 
-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).
 
-See the "notes.rewrite.<command>" configuration for a way of carrying
+See the "notes.rewrite.<command>" configuration for a way to carry
 notes across commands that rewrite commits.
 
 
-- 
1.7.1

  parent reply	other threads:[~2010-05-03 23:47 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 ` Jonathan Nieder [this message]
2010-05-04  7:09   ` [PATCH 4/4] Documentation/notes: nitpicks Thomas Rast
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=20100503234720.GD27483@progeny.tock \
    --to=jrnieder@gmail.com \
    --cc=Johannes.Schindelin@gmx.de \
    --cc=git@vger.kernel.org \
    --cc=johan@herland.net \
    --cc=trast@student.ethz.ch \
    /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).