summaryrefslogtreecommitdiff
path: root/Documentation/git-notes.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2011-05-18 15:44:37 -0700
committerJunio C Hamano <gitster@pobox.com>2011-05-19 10:44:44 -0700
commitc3ab1a8e4cb8a84967efcf45c5e6bee41b17f9f9 (patch)
tree207ae18917753171c9e1125cf19446319ae8ecd8 /Documentation/git-notes.txt
parentb602ed7dea968d72c5b3f61ca016de7f285d80ef (diff)
downloadgit-c3ab1a8e4cb8a84967efcf45c5e6bee41b17f9f9.tar.gz
notes remove: allow removing more than one
While "xargs -n1 git notes rm" is certainly a possible way to remove notes from many objects, this would create one notes "commit" per removal, which is not quite suitable for seasonal housekeeping. Allow taking more than one on the command line, and record their removal as a single atomic event if everthing goes well. Even though the old code insisted that "git notes rm" must be given only one object (or zero, in which case it would default to HEAD), this condition was not tested. Add tests to handle the new case where we feed multiple objects, and also make sure if there is a bad input, no change is recorded. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-notes.txt')
-rw-r--r--Documentation/git-notes.txt7
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 913ecd8c43..e2e1c4c88d 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -17,7 +17,7 @@ SYNOPSIS
'git notes' merge [-v | -q] [-s <strategy> ] <notes_ref>
'git notes' merge --commit [-v | -q]
'git notes' merge --abort [-v | -q]
-'git notes' remove [<object>]
+'git notes' remove [<object>...]
'git notes' prune [-n | -v]
'git notes' get-ref
@@ -106,8 +106,9 @@ When done, the user can either finalize the merge with
'git notes merge --abort'.
remove::
- Remove the notes for a given object (defaults to HEAD).
- This is equivalent to specifying an empty note message to
+ Remove the notes for given objects (defaults to HEAD). When
+ giving zero or one object from the command line, this is
+ equivalent to specifying an empty note message to
the `edit` subcommand.
prune::