Documentation/notes: nitpicks
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jonathan Nieder committed
May 8, 2010 at 22:37 UTC
1a3eb9a0325fc1d1d168b517210b7760d31d3022
1 file changed
+6
-6
Documentation/git-notes.txt
+6
-6
@@ -3,7 +3,7 @@ git-notes(1)
3
4
NAME
5
----
6
-git-notes - Add/inspect object notes
6
+git-notes - Add or inspect object notes
7
8
SYNOPSIS
9
--------
@@ -20,17 +20,17 @@ SYNOPSIS
20
21
DESCRIPTION
22
-----------
23
-This command allows you to add/remove notes to/from objects, without
24
-changing the objects themselves.
23
+Adds, removes, or reads notes attached to objects, without touching
24
+the objects themselves.
25
26
By default, notes are saved to and read from `refs/notes/commits`, but
27
this default can be overridden. See the OPTIONS, CONFIGURATION, and
28
ENVIRONMENT sections below. If this ref does not exist, it will be
29
quietly created when it is first needed to store a note.
30
31
-A typical use of notes is to extend a commit message without having
32
-to change the commit itself. Such commit notes can be shown by `git log`
33
-along with the original commit message. To discern these notes from the
31
+A typical use of notes is to supplement a commit message without
32
+changing the commit itself. Notes can be shown by 'git log' along with
33
+the original commit message. To distinguish these notes from the
34
message stored in the commit object, the notes are indented like the
35
message, after an unindented line saying "Notes (<refname>):" (or
36
"Notes:" for `refs/notes/commits`).