[PATCH 4/4] Documentation/notes: nitpicks
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- May 3, 2010, 23:47 UTC
- Message-ID
- <20100503234720.GD27483@progeny.tock>
- 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