undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation/notes: nitpicks

Browse Source 
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>
This commit is contained in:
Jonathan Nieder 2010-05-08 22:37:21 -05:00 committed by Junio C Hamano
parent c5ce183671
commit 1a3eb9a032
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/git-notes.txt
View File

@ -3,7 +3,7 @@ git-notes(1)
NAME NAME
---- ----
git-notes - Add/inspect object notes git-notes - Add or inspect object notes
SYNOPSIS SYNOPSIS
-------- --------
@ -20,17 +20,17 @@ SYNOPSIS
DESCRIPTION DESCRIPTION
----------- -----------
This command allows you to add/remove notes to/from objects, without Adds, removes, or reads notes attached to objects, without touching
changing the objects themselves. the objects themselves.
By default, notes are saved to and read from `refs/notes/commits`, but By default, notes are saved to and read from `refs/notes/commits`, but
this default can be overridden. See the OPTIONS, CONFIGURATION, and this default can be overridden. See the OPTIONS, CONFIGURATION, and
ENVIRONMENT sections below. If this ref does not exist, it will be ENVIRONMENT sections below. If this ref does not exist, it will be
quietly created when it is first needed to store a note. quietly created when it is first needed to store a note.
A typical use of notes is to extend a commit message without having A typical use of notes is to supplement a commit message without
to change the commit itself. Such commit notes can be shown by `git log` changing the commit itself. Notes can be shown by 'git log' along with
along with the original commit message. To discern these notes from the the original commit message. To distinguish these notes from the
message stored in the commit object, the notes are indented like the message stored in the commit object, the notes are indented like the
message, after an unindented line saying "Notes (<refname>):" (or message, after an unindented line saying "Notes (<refname>):" (or
"Notes:" for `refs/notes/commits`). "Notes:" for `refs/notes/commits`).