test-lib: unset GIT_NOTES_REF to stop it from influencing tests
[gitweb.git] / Documentation / git-notes.txt
index 8969f6f8fa652e2f6e9428f56190b8f2a2507c4c..14f73b988e556ecce1bea8a1dacf7284966832ae 100644 (file)
@@ -9,7 +9,10 @@ SYNOPSIS
 --------
 [verse]
 'git notes' [list [<object>]]
-'git notes' edit [-F <file> | -m <msg>] [<object>]
+'git notes' add [-f] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
+'git notes' copy [-f] <from-object> <to-object>
+'git notes' append [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
+'git notes' edit [<object>]
 'git notes' show [<object>]
 'git notes' remove [<object>]
 'git notes' prune
@@ -41,6 +44,22 @@ list::
        annotate (in the format "<note object> <annotated object>").
        This is the default subcommand if no subcommand is given.
 
+add::
+       Add notes for a given object (defaults to HEAD). Abort if the
+       object already has notes, abort. (use `-f` to overwrite an
+       existing note).
+
+copy::
+       Copy the notes for the first object onto the second object.
+       Abort if the second object already has notes, or if the first
+       objects has none. (use -f to overwrite existing notes to the
+       second object). This subcommand is equivalent to:
+       `git notes add [-f] -C $(git notes list <from-object>) <to-object>`
+
+append::
+       Append to the notes of an existing object (defaults to HEAD).
+       Creates a new notes object if needed.
+
 edit::
        Edit the notes for a given object (defaults to HEAD).
 
@@ -57,6 +76,11 @@ prune::
 
 OPTIONS
 -------
+-f::
+--force::
+       When adding notes to an object that already has notes,
+       overwrite the existing notes (instead of aborting).
+
 -m <msg>::
 --message=<msg>::
        Use the given note message (instead of prompting).
@@ -68,6 +92,14 @@ OPTIONS
        Take the note message from the given file.  Use '-' to
        read the note message from the standard input.
 
+-C <object>::
+--reuse-message=<object>::
+       Reuse the note message from the given note object.
+
+-c <object>::
+--reedit-message=<object>::
+       Like '-C', but with '-c' the editor is invoked, so that
+       the user can further edit the note message.
 
 Author
 ------