diff options
| author | Johan Herland <johan@herland.net> | 2010-02-13 22:28:25 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2010-02-13 19:36:14 -0800 |
| commit | 92b3385fca620f47580d695b80b96432c76f0822 (patch) | |
| tree | a82178402ddd241eaf1d37ab255a0d778535ceec /Documentation/git-notes.txt | |
| parent | a0b4dfa9b35a2ebac578ea5547b041bb78557238 (diff) | |
| download | git-92b3385fca620f47580d695b80b96432c76f0822.tar.gz git-92b3385fca620f47580d695b80b96432c76f0822.tar.xz | |
builtin-notes: Add "remove" subcommand for removing existing notes
Using "git notes remove" is equivalent to specifying an empty note message.
The patch includes tests verifying correct behaviour of the new subcommand.
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.txt | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index 0d1ada6a0..a52d23ac1 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -8,14 +8,14 @@ git-notes - Add/inspect commit notes SYNOPSIS -------- [verse] -'git notes' (edit [-F <file> | -m <msg>] | show) [commit] +'git notes' (edit [-F <file> | -m <msg>] | show | remove) [commit] DESCRIPTION ----------- -This command allows you to add notes to commit messages, without -changing the commit. To discern these notes from the message stored -in the commit object, the notes are indented like the message, after -an unindented line saying "Notes:". +This command allows you to add/remove notes to/from commit messages, +without changing the commit. To discern these notes from the message +stored in the commit object, the notes are indented like the message, +after an unindented line saying "Notes:". To disable commit notes, you have to set the config variable core.notesRef to the empty string. Alternatively, you can set it @@ -32,6 +32,11 @@ edit:: show:: Show the notes for a given commit (defaults to HEAD). +remove:: + Remove the notes for a given commit (defaults to HEAD). + This is equivalent to specifying an empty note message to + the `edit` subcommand. + OPTIONS ------- |