diff options
| author |  Johan Herland <johan@herland.net> | 2010-02-13 22:28:30 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2010-02-13 19:36:15 -0800 |
| commit | e397421abf1003c4da824441f91d8c990b70fa98 (patch) | |
| tree | ad1290da7749f57de950f13d7684bbbbd6f2c8dc /Documentation | |
| parent | Documentation: Generalize git-notes docs to 'objects' instead of 'commits' (diff) | |
| download | tgif-e397421abf1003c4da824441f91d8c990b70fa98.tar.xz | |
builtin-notes: Add "list" subcommand for listing note objects
"git notes list" will list all note objects in the current notes ref (in the
format "<note object> <annotated object>"). "git notes list <object>" will
list the note object associated with the given <object>, or fail loudly if
the given <object> has no associated notes.
If no arguments are given to "git notes", it defaults to the "list"
subcommand. This is for pseudo-compatibility with "git tag" and "git branch".
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')
| -rw-r--r-- | Documentation/git-notes.txt | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index 84db2a4678..4d29d5fb94 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -8,7 +8,12 @@ git-notes - Add/inspect object notes SYNOPSIS -------- [verse] -'git notes' (edit [-F <file> | -m <msg>] | show | remove | prune) [object] +'git notes' [list [<object>]] +'git notes' edit [-F <file> | -m <msg>] [<object>] +'git notes' show [<object>] +'git notes' remove [<object>] +'git notes' prune + DESCRIPTION ----------- @@ -30,6 +35,12 @@ by the environment variable "GIT_NOTES_REF". SUBCOMMANDS ----------- +list:: + List the notes object for a given object. If no object is + given, show a list of all note objects and the objects they + annotate (in the format "<note object> <annotated object>"). + This is the default subcommand if no subcommand is given. + edit:: Edit the notes for a given object (defaults to HEAD). |