aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-notes.txt
diff options
context:
space:
mode:
authorJohan Herland <johan@herland.net>2010-02-13 22:28:33 +0100
committerJunio C Hamano <gitster@pobox.com>2010-02-13 19:36:16 -0800
commit2347fae50b2f75c6c0b362bd9ef24249419ed2b1 (patch)
tree13975d09a3a5bbbe4b95d21ff8e0a54afe83bcdc /Documentation/git-notes.txt
parent7aa4754e552eff22d70d496dea73a9c7639d66d3 (diff)
downloadgit-2347fae50b2f75c6c0b362bd9ef24249419ed2b1.tar.gz
builtin-notes: Add "append" subcommand for appending to note objects
"git notes append" is equivalent to "git notes edit" except that instead of editing existing notes contents, you can only append to it. This is useful for quickly adding annotations like e.g.: git notes append -m "Acked-by: A U Thor <author@example.com>" "git notes append" takes the same -m/-F options as "git notes add". If there is no existing note to append to, "git notes append" is identical to "git notes add" (i.e. it adds a new note). The patch includes tests verifying correct behaviour of the new subcommand. Suggested-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Johan Herland <johan@herland.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-notes.txt')
-rw-r--r--Documentation/git-notes.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 94e12b57e4..35dd8fa8a0 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -10,6 +10,7 @@ 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>]
@@ -47,6 +48,10 @@ add::
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).