builtin/notes: add --allow-empty, to allow storing empty notes

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 <jhf@trifork.com>
Improved-by: Kyle J. McKay <mackyle@gmail.com>
Improved-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Johan Herland <johan@herland.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Johan Herland
2014-11-12 01:40:14 +01:00
committed by Junio C Hamano
parent 52694cdabb
commit d73a5b933d
3 changed files with 28 additions and 11 deletions

View File

@ -1242,7 +1242,8 @@ test_expect_success 'git notes get-ref (--ref)' '
test_expect_success 'setup testing of empty notes' '
test_unconfig core.notesRef &&
test_commit 16th &&
empty_blob=$(git hash-object -w /dev/null)
empty_blob=$(git hash-object -w /dev/null) &&
echo "$empty_blob" >expect_empty
'
while read cmd
@ -1252,6 +1253,13 @@ do
MSG= git notes $cmd &&
test_must_fail git notes list HEAD
"
test_expect_success "'git notes $cmd --allow-empty' stores empty note" "
test_might_fail git notes remove HEAD &&
MSG= git notes $cmd --allow-empty &&
git notes list HEAD >actual &&
test_cmp expect_empty actual
"
done <<\EOF
add
add -F /dev/null