diff options
| author | Jonathan Nieder <jrnieder@gmail.com> | 2010-05-08 22:37:21 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2010-05-08 22:30:03 -0700 |
| commit | 1a3eb9a0325fc1d1d168b517210b7760d31d3022 (patch) | |
| tree | 04413c9c4c6dee13984b749419d4efabca22715c /Documentation/git-notes.txt | |
| parent | c5ce1836719dc77e3c8495206653037cb5c4e511 (diff) | |
| download | git-1a3eb9a0325fc1d1d168b517210b7760d31d3022.tar.gz git-1a3eb9a0325fc1d1d168b517210b7760d31d3022.tar.xz | |
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>
Diffstat (limited to 'Documentation/git-notes.txt')
| -rw-r--r-- | Documentation/git-notes.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index d868535ee..de63ef074 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,17 +20,17 @@ 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 OPTIONS, CONFIGURATION, and ENVIRONMENT sections below. If this ref does not exist, it will be quietly created when it is first needed to store a note. -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 `refs/notes/commits`). |