# [PATCH 2/2] notes: Add --allow-empty, to allow storing empty notes 5 messages from 2014-11-05 to 2014-11-05. Participants: Johan Herland, Eric Sunshine, Junio C Hamano. Thread: https://gitlist.dev/t/37880 ## Johan Herland, 2014-11-05 01:32 Subject: [PATCH 1/2] t3312-notes-empty: Test that 'git notes' removes empty notes by default Message-ID: <1415151175-1682-1-git-send-email-johan@herland.net> URL: https://gitlist.dev/e/1415151175-1682-1-git-send-email-johan%40herland.net ``` Add test cases documenting the current behavior when trying to add/append/edit empty notes. This is in preparation for adding --allow-empty; to allow empty notes to be stored. Signed-off-by: Johan Herland --- t/t3312-notes-empty.sh | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) create mode 100755 t/t3312-notes-empty.sh diff --git a/t/t3312-notes-empty.sh b/t/t3312-notes-empty.sh new file mode 100755 index 0000000..2806d27 --- /dev/null +++ b/t/t3312-notes-empty.sh @@ -0,0 +1,58 @@ +#!/bin/sh + +test_description='Test adding/editing of empty notes' +. ./test-lib.sh + +cat >fake_editor.sh <<\EOF +#!/bin/sh +echo "$MSG" >"$1" +echo "$MSG" >& 2 +EOF +chmod a+x fake_editor.sh +GIT_EDITOR=./fake_editor.sh +export GIT_EDITOR + +test_expect_success 'setup' ' + test_commit one && + empty_blob=$(git hash-object -w /dev/null) +' + +cleanup_notes() { + git update-ref -d refs/notes/commits +} + +cat >expect_missing <<\EOF +commit d79ce1670bdcb76e6d1da2ae095e890ccb326ae9 +Author: A U Thor +Date: Thu Apr 7 15:13:13 2005 -0700 + + one +EOF + +verify_missing() { + git log -1 > actual && + test_cmp expect_missing actual && + ! git notes list HEAD +} + +for cmd in \ + 'add' \ + 'add -F /dev/null' \ + 'add -m ""' \ + 'add -c "$empty_blob"' \ + 'add -C "$empty_blob"' \ + 'append' \ + 'append -F /dev/null' \ + 'append -m ""' \ + 'append -c "$empty_blob"' \ + 'append -C "$empty_blob"' \ + 'edit' +do + test_expect_success "'git notes $cmd' removes empty note" " + cleanup_notes && + MSG= git notes $cmd && + verify_missing + " +done + +test_done -- 2.0.0.rc4.501.gdaf83ca ``` ## Johan Herland, 2014-11-05 01:32 Subject: [PATCH 2/2] notes: Add --allow-empty, to allow storing empty notes Message-ID: <1415151175-1682-2-git-send-email-johan@herland.net> URL: https://gitlist.dev/e/1415151175-1682-2-git-send-email-johan%40herland.net In-Reply-To: <1415151175-1682-1-git-send-email-johan@herland.net> ``` Although the "git notes" man page advertises that we support binary-safe notes addition (using the -C option), we currently do not support adding the empty note (i.e. using the empty blob to annotate an object). Instead, an empty note is always treated as an intent to remove the note altogether. Introduce the --allow-empty option to the add/append/edit subcommands, to explicitly allow an empty note to be stored into the notes tree. Also update the documentation, and add test cases for the new option. Reported-by: James H. Fisher Improved-by: Kyle J. McKay Signed-off-by: Johan Herland --- Documentation/git-notes.txt | 12 ++++++++---- builtin/notes.c | 25 +++++++++++++++---------- notes.c | 3 +-- t/t3312-notes-empty.sh | 20 +++++++++++++++++++- 4 files changed, 43 insertions(+), 17 deletions(-) diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt index 310f0a5..851518d 100644 --- a/Documentation/git-notes.txt +++ b/Documentation/git-notes.txt @@ -9,10 +9,10 @@ SYNOPSIS -------- [verse] 'git notes' [list [