Documentation: Generalize git-notes docs to 'objects' instead of 'commits'

Notes can annotate arbitrary objects (not only commits), but this is not
reflected in the current documentation.

This patch rewrites the git-notes documentation to talk about 'objects'
instead of 'commits'. However, the discussion on commit notes and how
they are displayed by 'git log' is largely preserved.

Finally, I add myself to the Author/Documentation credits, since most of
the lines in the git-notes code and docs are blamed on me.

Cc: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Johan Herland <johan@herland.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 3973f902657eb4330d8af97d8301e35371d70e18..84db2a4678acd9ec04706005514656dd216b80b7 100644 (file)
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -3,37 +3,41 @@ git-notes(1)
 
 NAME
 ----
 
 NAME
 ----

-git-notes - Add/inspect commit notes
+git-notes - Add/inspect object notes

 
 SYNOPSIS
 --------
 [verse]
 
 SYNOPSIS
 --------
 [verse]

-'git notes' (edit [-F <file> | -m <msg>] | show | remove | prune) [commit]
+'git notes' (edit [-F <file> | -m <msg>] | show | remove | prune) [object]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------

-This command allows you to add/remove notes to/from commit messages,
-without changing the commit.  To discern these notes from the message
-stored in the commit object, the notes are indented like the message,
-after an unindented line saying "Notes:".
+This command allows you to add/remove notes to/from objects, without
+changing the objects themselves.

 
 

-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".
+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
+message stored in the commit object, the notes are indented like the
+message, after an unindented line saying "Notes:".
+
+To disable 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".

 
 
 SUBCOMMANDS
 -----------
 
 edit::
 
 
 SUBCOMMANDS
 -----------
 
 edit::

-       Edit the notes for a given commit (defaults to HEAD).
+       Edit the notes for a given object (defaults to HEAD).

 
 show::
 
 show::

-       Show the notes for a given commit (defaults to HEAD).
+       Show the notes for a given object (defaults to HEAD).

 
 remove::
 
 remove::

-       Remove the notes for a given commit (defaults to HEAD).
+       Remove the notes for a given object (defaults to HEAD).

        This is equivalent to specifying an empty note message to
        the `edit` subcommand.
 
        This is equivalent to specifying an empty note message to
        the `edit` subcommand.
 


@@ -54,11 +58,12 @@ OPTIONS
 
 Author
 ------
 
 Author
 ------

-Written by Johannes Schindelin <johannes.schindelin@gmx.de>
+Written by Johannes Schindelin <johannes.schindelin@gmx.de> and
+Johan Herland <johan@herland.net>

 
 Documentation
 -------------
 
 Documentation
 -------------

-Documentation by Johannes Schindelin
+Documentation by Johannes Schindelin and Johan Herland

 
 GIT
 ---
 
 GIT
 ---