builtin-notes: Add "append" subcommand for appending to note objects
[gitweb.git] / Documentation / git-notes.txt
index 8969f6f8fa652e2f6e9428f56190b8f2a2507c4c..35dd8fa8a0842424415c3f9f6c439dfe12cb9ee8 100644 (file)
@@ -9,6 +9,8 @@ SYNOPSIS
 --------
 [verse]
 'git notes' [list [<object>]]
+'git notes' add [-f] [-F <file> | -m <msg>] [<object>]
+'git notes' append [-F <file> | -m <msg>] [<object>]
 'git notes' edit [-F <file> | -m <msg>] [<object>]
 'git notes' show [<object>]
 'git notes' remove [<object>]
@@ -41,6 +43,15 @@ 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).
+
+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 +68,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).