[PATCHv3 0/5] Handling empty notes

[PATCHv3 0/5] Handling empty notes

[Johan Herland]

Changes v1 -> v2:
 - Incorporate Eric's feedback
 - Factor out an initial fix, needed before adding the tests

Changes v2 -> v3:
 - Incorporate Junio's feedback
 - Move tests from t3312 to t3301
 - Refactor the display of empty notes (the part concerning
   git-log) into a separate follow-up patch (#4)
 - Add a final (optional) patch with some whitespace and other
   cleanups in t3301. Feel free to drop this if it's too much
   churn.


Have fun! :)

...Johan

Johan Herland (5):
  builtin/notes: Fix premature failure when trying to add the empty blob
  t3301: Verify that 'git notes' removes empty notes by default
  builtin/notes: Add --allow-empty, to allow storing empty notes
  notes: Empty notes should be shown by 'git log'
  t3301: Use write_script(), nitpick whitespace

 Documentation/git-notes.txt |  12 +-
 builtin/notes.c             |  25 ++--
 notes.c                     |   3 +-
 t/t3301-notes.sh            | 301 +++++++++++++++++++++++++-------------------
 4 files changed, 197 insertions(+), 144 deletions(-)

-- 
2.0.0.rc4.501.gdaf83ca

[PATCHv3 1/5] builtin/notes: Fix premature failure when trying to add the empty blob

[Johan Herland]

This fixes a small buglet when trying to explicitly add the empty blob
as a note object using the -c or -C option to git notes add/append.
Instead of failing with a nonsensical error message indicating that the
empty blob does not exist, we should rather behave as if an empty notes
message was given (e.g. using -m "" or -F /dev/null).

The next patch contains a test that verifies the fixed behavior.

Found-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Johan Herland <johan@herland.net>
---
 builtin/notes.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/builtin/notes.c b/builtin/notes.c
index 68b6cd8..9ee6816 100644
--- a/builtin/notes.c
+++ b/builtin/notes.c
@@ -266,7 +266,7 @@ static int parse_reuse_arg(const struct option *opt, const char *arg, int unset)
 
 	if (get_sha1(arg, object))
 		die(_("Failed to resolve '%s' as a valid ref."), arg);
-	if (!(buf = read_sha1_file(object, &type, &len)) || !len) {
+	if (!(buf = read_sha1_file(object, &type, &len))) {
 		free(buf);
 		die(_("Failed to read object '%s'."), arg);
 	}
-- 
2.0.0.rc4.501.gdaf83ca

[PATCHv3 2/5] t3301: Verify that 'git notes' removes empty notes by default

[Johan Herland]

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.

Improved-by: Eric Sunshine <sunshine@sunshineco.com>
Improved-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Johan Herland <johan@herland.net>
---
 t/t3301-notes.sh | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
index cfd67ff..33f0558 100755
--- a/t/t3301-notes.sh
+++ b/t/t3301-notes.sh
@@ -1239,4 +1239,31 @@ test_expect_success 'git notes get-ref (--ref)' '
 	test "$(GIT_NOTES_REF=refs/notes/bar git notes --ref=baz get-ref)" = "refs/notes/baz"
 '
 
+test_expect_success 'setup testing of empty notes' '
+	git config --unset core.notesRef &&
+	test_commit 16th &&
+	empty_blob=$(git hash-object -w /dev/null)
+'
+
+while read cmd
+do
+	test_expect_success "'git notes $cmd' removes empty note" "
+		test_might_fail git notes remove HEAD &&
+		MSG= git notes $cmd &&
+		test_must_fail git notes list HEAD
+	"
+done <<\EOF
+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
+EOF
+
 test_done
-- 
2.0.0.rc4.501.gdaf83ca

[PATCHv3 3/5] builtin/notes: Add --allow-empty, to allow storing empty notes

[Johan Herland]

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>
---
 Documentation/git-notes.txt | 12 ++++++++----
 builtin/notes.c             | 23 ++++++++++++++---------
 t/t3301-notes.sh            | 10 +++++++++-
 3 files changed, 31 insertions(+), 14 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 [<object>]]
-'git notes' add [-f] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
+'git notes' add [-f] [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
 'git notes' copy [-f] ( --stdin | <from-object> <to-object> )
-'git notes' append [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
-'git notes' edit [<object>]
+'git notes' append [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
+'git notes' edit [--allow-empty] [<object>]
 'git notes' show [<object>]
 'git notes' merge [-v | -q] [-s <strategy> ] <notes-ref>
 'git notes' merge --commit [-v | -q]
@@ -155,6 +155,10 @@ OPTIONS
 	Like '-C', but with '-c' the editor is invoked, so that
 	the user can further edit the note message.
 
+--allow-empty::
+	Allow an empty note object to be stored. The default behavior is
+	to automatically remove empty notes.
+
 --ref <ref>::
 	Manipulate the notes tree in <ref>.  This overrides
 	'GIT_NOTES_REF' and the "core.notesRef" configuration.  The ref
@@ -287,7 +291,7 @@ arbitrary files using 'git hash-object':
 ------------
 $ cc *.c
 $ blob=$(git hash-object -w a.out)
-$ git notes --ref=built add -C "$blob" HEAD
+$ git notes --ref=built add --allow-empty -C "$blob" HEAD
 ------------
 
 (You cannot simply use `git notes --ref=built add -F a.out HEAD`
diff --git a/builtin/notes.c b/builtin/notes.c
index 9ee6816..038a419 100644
--- a/builtin/notes.c
+++ b/builtin/notes.c
@@ -22,10 +22,10 @@
 
 static const char * const git_notes_usage[] = {
 	N_("git notes [--ref <notes_ref>] [list [<object>]]"),
-	N_("git notes [--ref <notes_ref>] add [-f] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]"),
+	N_("git notes [--ref <notes_ref>] add [-f] [--allow-empty] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]"),
 	N_("git notes [--ref <notes_ref>] copy [-f] <from-object> <to-object>"),
-	N_("git notes [--ref <notes_ref>] append [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]"),
-	N_("git notes [--ref <notes_ref>] edit [<object>]"),
+	N_("git notes [--ref <notes_ref>] append [--allow-empty] [-m <msg> | -F <file> | (-c | -C) <object>] [<object>]"),
+	N_("git notes [--ref <notes_ref>] edit [--allow-empty] [<object>]"),
 	N_("git notes [--ref <notes_ref>] show [<object>]"),
 	N_("git notes [--ref <notes_ref>] merge [-v | -q] [-s <strategy> ] <notes_ref>"),
 	N_("git notes merge --commit [-v | -q]"),
@@ -150,8 +150,8 @@ static void write_commented_object(int fd, const unsigned char *object)
 }
 
 static void create_note(const unsigned char *object, struct msg_arg *msg,
-			int append_only, const unsigned char *prev,
-			unsigned char *result)
+			int append_only, int allow_empty,
+			const unsigned char *prev, unsigned char *result)
 {
 	char *path = NULL;
 
@@ -202,7 +202,7 @@ static void create_note(const unsigned char *object, struct msg_arg *msg,
 		free(prev_buf);
 	}
 
-	if (!msg->buf.len) {
+	if (!allow_empty && !msg->buf.len) {
 		fprintf(stderr, _("Removing note for object %s\n"),
 			sha1_to_hex(object));
 		hashclr(result);
@@ -397,7 +397,7 @@ static int append_edit(int argc, const char **argv, const char *prefix);
 
 static int add(int argc, const char **argv, const char *prefix)
 {
-	int retval = 0, force = 0;
+	int retval = 0, force = 0, allow_empty = 0;
 	const char *object_ref;
 	struct notes_tree *t;
 	unsigned char object[20], new_note[20];
@@ -417,6 +417,8 @@ static int add(int argc, const char **argv, const char *prefix)
 		{ OPTION_CALLBACK, 'C', "reuse-message", &msg, N_("object"),
 			N_("reuse specified note object"), PARSE_OPT_NONEG,
 			parse_reuse_arg},
+		OPT_BOOL(0, "allow-empty", &allow_empty,
+			N_("allow storing empty note")),
 		OPT__FORCE(&force, N_("replace existing notes")),
 		OPT_END()
 	};
@@ -460,7 +462,7 @@ static int add(int argc, const char **argv, const char *prefix)
 			sha1_to_hex(object));
 	}
 
-	create_note(object, &msg, 0, note, new_note);
+	create_note(object, &msg, 0, allow_empty, note, new_note);
 
 	if (is_null_sha1(new_note))
 		remove_note(t, object);
@@ -554,6 +556,7 @@ out:
 
 static int append_edit(int argc, const char **argv, const char *prefix)
 {
+	int allow_empty = 0;
 	const char *object_ref;
 	struct notes_tree *t;
 	unsigned char object[20], new_note[20];
@@ -574,6 +577,8 @@ static int append_edit(int argc, const char **argv, const char *prefix)
 		{ OPTION_CALLBACK, 'C', "reuse-message", &msg, N_("object"),
 			N_("reuse specified note object"), PARSE_OPT_NONEG,
 			parse_reuse_arg},
+		OPT_BOOL(0, "allow-empty", &allow_empty,
+			N_("allow storing empty note")),
 		OPT_END()
 	};
 	int edit = !strcmp(argv[0], "edit");
@@ -600,7 +605,7 @@ static int append_edit(int argc, const char **argv, const char *prefix)
 	t = init_notes_check(argv[0]);
 	note = get_note(t, object);
 
-	create_note(object, &msg, !edit, note, new_note);
+	create_note(object, &msg, !edit, allow_empty, note, new_note);
 
 	if (is_null_sha1(new_note))
 		remove_note(t, object);
diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
index 33f0558..8280a1a 100755
--- a/t/t3301-notes.sh
+++ b/t/t3301-notes.sh
@@ -1242,7 +1242,8 @@ test_expect_success 'git notes get-ref (--ref)' '
 test_expect_success 'setup testing of empty notes' '
 	git config --unset 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
-- 
2.0.0.rc4.501.gdaf83ca

[PATCHv3 4/5] notes: Empty notes should be shown by 'git log'

[Johan Herland]

If the user has gone through the trouble of explicitly adding an empty
note, then "git log" should not silently skip it (as if it didn't exist).

Signed-off-by: Johan Herland <johan@herland.net>
---
 notes.c          |  3 +--
 t/t3301-notes.sh | 12 ++++++++++++
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/notes.c b/notes.c
index 5fe691d..62bc6e1 100644
--- a/notes.c
+++ b/notes.c
@@ -1218,8 +1218,7 @@ static void format_note(struct notes_tree *t, const unsigned char *object_sha1,
 	if (!sha1)
 		return;
 
-	if (!(msg = read_sha1_file(sha1, &type, &msglen)) || !msglen ||
-			type != OBJ_BLOB) {
+	if (!(msg = read_sha1_file(sha1, &type, &msglen)) || type != OBJ_BLOB) {
 		free(msg);
 		return;
 	}
diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
index 8280a1a..f5d8193 100755
--- a/t/t3301-notes.sh
+++ b/t/t3301-notes.sh
@@ -1274,4 +1274,16 @@ append -C "$empty_blob"
 edit
 EOF
 
+test_expect_success 'empty notes are displayed by git log' '
+	test_commit 17th &&
+	git log -1 >expect &&
+	cat >>expect <<\EOF &&
+
+Notes:
+EOF
+	git notes add -C "$empty_blob" --allow-empty &&
+	git log -1 >actual &&
+	test_cmp expect actual
+'
+
 test_done
-- 
2.0.0.rc4.501.gdaf83ca

[PATCHv3 5/5] t3301: Use write_script(), nitpick whitespace

[Johan Herland]

Signed-off-by: Johan Herland <johan@herland.net>
---

Drop this if it's too much churn.

...Johan

 t/t3301-notes.sh | 254 +++++++++++++++++++++++++++----------------------------
 1 file changed, 126 insertions(+), 128 deletions(-)

diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
index f5d8193..80caee0 100755
--- a/t/t3301-notes.sh
+++ b/t/t3301-notes.sh
@@ -7,13 +7,11 @@ test_description='Test commit notes'
 
 . ./test-lib.sh
 
-cat > fake_editor.sh << \EOF
-#!/bin/sh
-echo "$MSG" > "$1"
-echo "$MSG" >& 2
+write_script fake_editor <<\EOF
+echo "$MSG" >"$1"
+echo "$MSG" >&2
 EOF
-chmod a+x fake_editor.sh
-GIT_EDITOR=./fake_editor.sh
+GIT_EDITOR=./fake_editor
 export GIT_EDITOR
 
 test_expect_success 'cannot annotate non-existing HEAD' '
@@ -21,11 +19,11 @@ test_expect_success 'cannot annotate non-existing HEAD' '
 '
 
 test_expect_success setup '
-	: > a1 &&
+	: >a1 &&
 	git add a1 &&
 	test_tick &&
 	git commit -m 1st &&
-	: > a2 &&
+	: >a2 &&
 	git add a2 &&
 	test_tick &&
 	git commit -m 2nd
@@ -131,7 +129,7 @@ test_expect_success 'can overwrite existing note with "git notes add -f"' '
 	test_must_fail git notes show HEAD^
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 268048bfb8a1fb38e703baceb8ab235421bf80c5
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:14:13 2005 -0700
@@ -144,12 +142,12 @@ EOF
 
 test_expect_success 'show notes' '
 	! (git cat-file commit HEAD | grep b1) &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect output
 '
 
 test_expect_success 'create multi-line notes (setup)' '
-	: > a3 &&
+	: >a3 &&
 	git add a3 &&
 	test_tick &&
 	git commit -m 3rd &&
@@ -158,7 +156,7 @@ c3c3c3c3
 d3d3d3" git notes add
 '
 
-cat > expect-multiline << EOF
+cat >expect-multiline <<EOF
 commit 1584215f1d29c65e99c6c6848626553fdd07fd75
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:15:13 2005 -0700
@@ -171,23 +169,23 @@ Notes:
     d3d3d3
 EOF
 
-printf "\n" >> expect-multiline
-cat expect >> expect-multiline
+printf "\n" >>expect-multiline
+cat expect >>expect-multiline
 
 test_expect_success 'show multi-line notes' '
-	git log -2 > output &&
+	git log -2 >output &&
 	test_cmp expect-multiline output
 '
 test_expect_success 'create -F notes (setup)' '
-	: > a4 &&
+	: >a4 &&
 	git add a4 &&
 	test_tick &&
 	git commit -m 4th &&
-	echo "xyzzy" > note5 &&
+	echo "xyzzy" >note5 &&
 	git notes add -F note5
 '
 
-cat > expect-F << EOF
+cat >expect-F <<EOF
 commit 15023535574ded8b1a89052b32673f84cf9582b8
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:16:13 2005 -0700
@@ -198,22 +196,22 @@ Notes:
     xyzzy
 EOF
 
-printf "\n" >> expect-F
-cat expect-multiline >> expect-F
+printf "\n" >>expect-F
+cat expect-multiline >>expect-F
 
 test_expect_success 'show -F notes' '
-	git log -3 > output &&
+	git log -3 >output &&
 	test_cmp expect-F output
 '
 
 test_expect_success 'Re-adding -F notes without -f fails' '
-	echo "zyxxy" > note5 &&
+	echo "zyxxy" >note5 &&
 	test_must_fail git notes add -F note5 &&
-	git log -3 > output &&
+	git log -3 >output &&
 	test_cmp expect-F output
 '
 
-cat >expect << EOF
+cat >expect <<EOF
 commit 15023535574ded8b1a89052b32673f84cf9582b8
 tree e070e3af51011e47b183c33adf9736736a525709
 parent 1584215f1d29c65e99c6c6848626553fdd07fd75
@@ -305,7 +303,7 @@ test_expect_success 'git log --no-notes resets ref list' '
 '
 
 test_expect_success 'create -m notes (setup)' '
-	: > a5 &&
+	: >a5 &&
 	git add a5 &&
 	test_tick &&
 	git commit -m 5th &&
@@ -315,7 +313,7 @@ baz"
 '
 
 whitespace="    "
-cat > expect-m << EOF
+cat >expect-m <<EOF
 commit bd1753200303d0a0344be813e504253b3d98e74d
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:17:13 2005 -0700
@@ -330,11 +328,11 @@ $whitespace
     baz
 EOF
 
-printf "\n" >> expect-m
-cat expect-F >> expect-m
+printf "\n" >>expect-m
+cat expect-F >>expect-m
 
 test_expect_success 'show -m notes' '
-	git log -4 > output &&
+	git log -4 >output &&
 	test_cmp expect-m output
 '
 
@@ -342,7 +340,7 @@ test_expect_success 'remove note with add -f -F /dev/null (setup)' '
 	git notes add -f -F /dev/null
 '
 
-cat > expect-rm-F << EOF
+cat >expect-rm-F <<EOF
 commit bd1753200303d0a0344be813e504253b3d98e74d
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:17:13 2005 -0700
@@ -350,11 +348,11 @@ Date:   Thu Apr 7 15:17:13 2005 -0700
     5th
 EOF
 
-printf "\n" >> expect-rm-F
-cat expect-F >> expect-rm-F
+printf "\n" >>expect-rm-F
+cat expect-F >>expect-rm-F
 
 test_expect_success 'verify note removal with -F /dev/null' '
-	git log -4 > output &&
+	git log -4 >output &&
 	test_cmp expect-rm-F output &&
 	test_must_fail git notes show
 '
@@ -364,12 +362,12 @@ test_expect_success 'do not create empty note with -m "" (setup)' '
 '
 
 test_expect_success 'verify non-creation of note with -m ""' '
-	git log -4 > output &&
+	git log -4 >output &&
 	test_cmp expect-rm-F output &&
 	test_must_fail git notes show
 '
 
-cat > expect-combine_m_and_F << EOF
+cat >expect-combine_m_and_F <<EOF
 foo
 
 xyzzy
@@ -382,10 +380,10 @@ baz
 EOF
 
 test_expect_success 'create note with combination of -m and -F' '
-	echo "xyzzy" > note_a &&
-	echo "zyxxy" > note_b &&
+	echo "xyzzy" >note_a &&
+	echo "zyxxy" >note_b &&
 	git notes add -m "foo" -F note_a -m "bar" -F note_b -m "baz" &&
-	git notes show > output &&
+	git notes show >output &&
 	test_cmp expect-combine_m_and_F output
 '
 
@@ -394,7 +392,7 @@ test_expect_success 'remove note with "git notes remove" (setup)' '
 	git notes remove
 '
 
-cat > expect-rm-remove << EOF
+cat >expect-rm-remove <<EOF
 commit bd1753200303d0a0344be813e504253b3d98e74d
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:17:13 2005 -0700
@@ -408,24 +406,24 @@ Date:   Thu Apr 7 15:16:13 2005 -0700
     4th
 EOF
 
-printf "\n" >> expect-rm-remove
-cat expect-multiline >> expect-rm-remove
+printf "\n" >>expect-rm-remove
+cat expect-multiline >>expect-rm-remove
 
 test_expect_success 'verify note removal with "git notes remove"' '
-	git log -4 > output &&
+	git log -4 >output &&
 	test_cmp expect-rm-remove output &&
 	test_must_fail git notes show HEAD^
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 c18dc024e14f08d18d14eea0d747ff692d66d6a3 1584215f1d29c65e99c6c6848626553fdd07fd75
 c9c6af7f78bc47490dbf3e822cf2f3c24d4b9061 268048bfb8a1fb38e703baceb8ab235421bf80c5
 EOF
 
 test_expect_success 'removing non-existing note should not create new commit' '
-	git rev-parse --verify refs/notes/commits > before_commit &&
+	git rev-parse --verify refs/notes/commits >before_commit &&
 	test_must_fail git notes remove HEAD^ &&
-	git rev-parse --verify refs/notes/commits > after_commit &&
+	git rev-parse --verify refs/notes/commits >after_commit &&
 	test_cmp before_commit after_commit
 '
 
@@ -505,33 +503,33 @@ test_expect_success 'removing with --stdin --ignore-missing' '
 '
 
 test_expect_success 'list notes with "git notes list"' '
-	git notes list > output &&
+	git notes list >output &&
 	test_cmp expect output
 '
 
 test_expect_success 'list notes with "git notes"' '
-	git notes > output &&
+	git notes >output &&
 	test_cmp expect output
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 c18dc024e14f08d18d14eea0d747ff692d66d6a3
 EOF
 
 test_expect_success 'list specific note with "git notes list <object>"' '
-	git notes list HEAD^^ > output &&
+	git notes list HEAD^^ >output &&
 	test_cmp expect output
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 EOF
 
 test_expect_success 'listing non-existing notes fails' '
-	test_must_fail git notes list HEAD > output &&
+	test_must_fail git notes list HEAD >output &&
 	test_cmp expect output
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 Initial set of notes
 
 More notes appended with git notes append
@@ -540,24 +538,24 @@ EOF
 test_expect_success 'append to existing note with "git notes append"' '
 	git notes add -m "Initial set of notes" &&
 	git notes append -m "More notes appended with git notes append" &&
-	git notes show > output &&
+	git notes show >output &&
 	test_cmp expect output
 '
 
-cat > expect_list << EOF
+cat >expect_list <<EOF
 c18dc024e14f08d18d14eea0d747ff692d66d6a3 1584215f1d29c65e99c6c6848626553fdd07fd75
 c9c6af7f78bc47490dbf3e822cf2f3c24d4b9061 268048bfb8a1fb38e703baceb8ab235421bf80c5
 4b6ad22357cc8a1296720574b8d2fbc22fab0671 bd1753200303d0a0344be813e504253b3d98e74d
 EOF
 
 test_expect_success '"git notes list" does not expand to "git notes list HEAD"' '
-	git notes list > output &&
+	git notes list >output &&
 	test_cmp expect_list output
 '
 
 test_expect_success 'appending empty string does not change existing note' '
 	git notes append -m "" &&
-	git notes show > output &&
+	git notes show >output &&
 	test_cmp expect output
 '
 
@@ -567,7 +565,7 @@ test_expect_success 'git notes append == add when there is no existing note' '
 	git notes append -m "Initial set of notes
 
 More notes appended with git notes append" &&
-	git notes show > output &&
+	git notes show >output &&
 	test_cmp expect output
 '
 
@@ -579,14 +577,14 @@ test_expect_success 'appending empty string to non-existing note does not create
 '
 
 test_expect_success 'create other note on a different notes ref (setup)' '
-	: > a6 &&
+	: >a6 &&
 	git add a6 &&
 	test_tick &&
 	git commit -m 6th &&
 	GIT_NOTES_REF="refs/notes/other" git notes add -m "other note"
 '
 
-cat > expect-other << EOF
+cat >expect-other <<EOF
 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:18:13 2005 -0700
@@ -597,7 +595,7 @@ Notes (other):
     other note
 EOF
 
-cat > expect-not-other << EOF
+cat >expect-not-other <<EOF
 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:18:13 2005 -0700
@@ -606,27 +604,27 @@ Date:   Thu Apr 7 15:18:13 2005 -0700
 EOF
 
 test_expect_success 'Do not show note on other ref by default' '
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect-not-other output
 '
 
 test_expect_success 'Do show note when ref is given in GIT_NOTES_REF' '
-	GIT_NOTES_REF="refs/notes/other" git log -1 > output &&
+	GIT_NOTES_REF="refs/notes/other" git log -1 >output &&
 	test_cmp expect-other output
 '
 
 test_expect_success 'Do show note when ref is given in core.notesRef config' '
 	git config core.notesRef "refs/notes/other" &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect-other output
 '
 
 test_expect_success 'Do not show note when core.notesRef is overridden' '
-	GIT_NOTES_REF="refs/notes/wrong" git log -1 > output &&
+	GIT_NOTES_REF="refs/notes/wrong" git log -1 >output &&
 	test_cmp expect-not-other output
 '
 
-cat > expect-both << EOF
+cat >expect-both <<EOF
 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:18:13 2005 -0700
@@ -655,14 +653,14 @@ test_expect_success 'Show all notes when notes.displayRef=refs/notes/*' '
 	GIT_NOTES_REF=refs/notes/commits git notes add -m"order test" &&
 	git config --unset core.notesRef &&
 	git config notes.displayRef "refs/notes/*" &&
-	git log -2 > output &&
+	git log -2 >output &&
 	test_cmp expect-both output
 '
 
 test_expect_success 'core.notesRef is implicitly in notes.displayRef' '
 	git config core.notesRef refs/notes/commits &&
 	git config notes.displayRef refs/notes/other &&
-	git log -2 > output &&
+	git log -2 >output &&
 	test_cmp expect-both output
 '
 
@@ -670,11 +668,11 @@ test_expect_success 'notes.displayRef can be given more than once' '
 	git config --unset core.notesRef &&
 	git config notes.displayRef refs/notes/commits &&
 	git config --add notes.displayRef refs/notes/other &&
-	git log -2 > output &&
+	git log -2 >output &&
 	test_cmp expect-both output
 '
 
-cat > expect-both-reversed << EOF
+cat >expect-both-reversed <<EOF
 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:18:13 2005 -0700
@@ -692,7 +690,7 @@ test_expect_success 'notes.displayRef respects order' '
 	git config core.notesRef refs/notes/other &&
 	git config --unset-all notes.displayRef &&
 	git config notes.displayRef refs/notes/commits &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect-both-reversed output
 '
 
@@ -700,11 +698,11 @@ test_expect_success 'GIT_NOTES_DISPLAY_REF works' '
 	git config --unset-all core.notesRef &&
 	git config --unset-all notes.displayRef &&
 	GIT_NOTES_DISPLAY_REF=refs/notes/commits:refs/notes/other \
-		git log -2 > output &&
+		git log -2 >output &&
 	test_cmp expect-both output
 '
 
-cat > expect-none << EOF
+cat >expect-none <<EOF
 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:18:13 2005 -0700
@@ -720,16 +718,16 @@ EOF
 
 test_expect_success 'GIT_NOTES_DISPLAY_REF overrides config' '
 	git config notes.displayRef "refs/notes/*" &&
-	GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log -2 > output &&
+	GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log -2 >output &&
 	test_cmp expect-none output
 '
 
 test_expect_success '--show-notes=* adds to GIT_NOTES_DISPLAY_REF' '
-	GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log --show-notes=* -2 > output &&
+	GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log --show-notes=* -2 >output &&
 	test_cmp expect-both output
 '
 
-cat > expect-commits << EOF
+cat >expect-commits <<EOF
 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:18:13 2005 -0700
@@ -741,41 +739,41 @@ Notes:
 EOF
 
 test_expect_success '--no-standard-notes' '
-	git log --no-standard-notes --show-notes=commits -1 > output &&
+	git log --no-standard-notes --show-notes=commits -1 >output &&
 	test_cmp expect-commits output
 '
 
 test_expect_success '--standard-notes' '
 	git log --no-standard-notes --show-notes=commits \
-		--standard-notes -2 > output &&
+		--standard-notes -2 >output &&
 	test_cmp expect-both output
 '
 
 test_expect_success '--show-notes=ref accumulates' '
 	git log --show-notes=other --show-notes=commits \
-		 --no-standard-notes -1 > output &&
+		 --no-standard-notes -1 >output &&
 	test_cmp expect-both-reversed output
 '
 
 test_expect_success 'Allow notes on non-commits (trees, blobs, tags)' '
 	git config core.notesRef refs/notes/other &&
-	echo "Note on a tree" > expect &&
+	echo "Note on a tree" >expect &&
 	git notes add -m "Note on a tree" HEAD: &&
-	git notes show HEAD: > actual &&
+	git notes show HEAD: >actual &&
 	test_cmp expect actual &&
-	echo "Note on a blob" > expect &&
+	echo "Note on a blob" >expect &&
 	filename=$(git ls-tree --name-only HEAD | head -n1) &&
 	git notes add -m "Note on a blob" HEAD:$filename &&
-	git notes show HEAD:$filename > actual &&
+	git notes show HEAD:$filename >actual &&
 	test_cmp expect actual &&
-	echo "Note on a tag" > expect &&
+	echo "Note on a tag" >expect &&
 	git tag -a -m "This is an annotated tag" foobar HEAD^ &&
 	git notes add -m "Note on a tag" foobar &&
-	git notes show foobar > actual &&
+	git notes show foobar >actual &&
 	test_cmp expect actual
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 2ede89468182a62d0bde2583c736089bcf7d7e92
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:19:13 2005 -0700
@@ -787,18 +785,18 @@ Notes (other):
 EOF
 
 test_expect_success 'create note from other note with "git notes add -C"' '
-	: > a7 &&
+	: >a7 &&
 	git add a7 &&
 	test_tick &&
 	git commit -m 7th &&
 	git notes add -C $(git notes list HEAD^) &&
-	git log -1 > actual &&
+	git log -1 >actual &&
 	test_cmp expect actual &&
 	test "$(git notes list HEAD)" = "$(git notes list HEAD^)"
 '
 
 test_expect_success 'create note from non-existing note with "git notes add -C" fails' '
-	: > a8 &&
+	: >a8 &&
 	git add a8 &&
 	test_tick &&
 	git commit -m 8th &&
@@ -814,7 +812,7 @@ test_expect_success 'create note from non-blob with "git notes add -C" fails' '
 	test_must_fail git notes list HEAD
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 80d796defacd5db327b7a4e50099663902fbdc5c
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:20:13 2005 -0700
@@ -828,12 +826,12 @@ EOF
 test_expect_success 'create note from blob with "git notes add -C" reuses blob id' '
 	blob=$(echo "This is a blob object" | git hash-object -w --stdin) &&
 	git notes add -C $blob &&
-	git log -1 > actual &&
+	git log -1 >actual &&
 	test_cmp expect actual &&
 	test "$(git notes list HEAD)" = "$blob"
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 016e982bad97eacdbda0fcbd7ce5b0ba87c81f1b
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:21:13 2005 -0700
@@ -845,17 +843,17 @@ Notes (other):
 EOF
 
 test_expect_success 'create note from other note with "git notes add -c"' '
-	: > a9 &&
+	: >a9 &&
 	git add a9 &&
 	test_tick &&
 	git commit -m 9th &&
 	MSG="yet another note" git notes add -c $(git notes list HEAD^^) &&
-	git log -1 > actual &&
+	git log -1 >actual &&
 	test_cmp expect actual
 '
 
 test_expect_success 'create note from non-existing note with "git notes add -c" fails' '
-	: > a10 &&
+	: >a10 &&
 	git add a10 &&
 	test_tick &&
 	git commit -m 10th &&
@@ -863,7 +861,7 @@ test_expect_success 'create note from non-existing note with "git notes add -c"
 	test_must_fail git notes list HEAD
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 016e982bad97eacdbda0fcbd7ce5b0ba87c81f1b
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:21:13 2005 -0700
@@ -878,11 +876,11 @@ EOF
 
 test_expect_success 'append to note from other note with "git notes append -C"' '
 	git notes append -C $(git notes list HEAD^) HEAD^ &&
-	git log -1 HEAD^ > actual &&
+	git log -1 HEAD^ >actual &&
 	test_cmp expect actual
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit ffed603236bfa3891c49644257a83598afe8ae5a
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:22:13 2005 -0700
@@ -895,11 +893,11 @@ EOF
 
 test_expect_success 'create note from other note with "git notes append -c"' '
 	MSG="other note" git notes append -c $(git notes list HEAD^) &&
-	git log -1 > actual &&
+	git log -1 >actual &&
 	test_cmp expect actual
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit ffed603236bfa3891c49644257a83598afe8ae5a
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:22:13 2005 -0700
@@ -914,11 +912,11 @@ EOF
 
 test_expect_success 'append to note from other note with "git notes append -c"' '
 	MSG="yet another note" git notes append -c $(git notes list HEAD) &&
-	git log -1 > actual &&
+	git log -1 >actual &&
 	test_cmp expect actual
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 6352c5e33dbcab725fe0579be16aa2ba8eb369be
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:23:13 2005 -0700
@@ -932,24 +930,24 @@ $whitespace
 EOF
 
 test_expect_success 'copy note with "git notes copy"' '
-	: > a11 &&
+	: >a11 &&
 	git add a11 &&
 	test_tick &&
 	git commit -m 11th &&
 	git notes copy HEAD^ HEAD &&
-	git log -1 > actual &&
+	git log -1 >actual &&
 	test_cmp expect actual &&
 	test "$(git notes list HEAD)" = "$(git notes list HEAD^)"
 '
 
 test_expect_success 'prevent overwrite with "git notes copy"' '
 	test_must_fail git notes copy HEAD~2 HEAD &&
-	git log -1 > actual &&
+	git log -1 >actual &&
 	test_cmp expect actual &&
 	test "$(git notes list HEAD)" = "$(git notes list HEAD^)"
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 6352c5e33dbcab725fe0579be16aa2ba8eb369be
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:23:13 2005 -0700
@@ -964,24 +962,24 @@ EOF
 
 test_expect_success 'allow overwrite with "git notes copy -f"' '
 	git notes copy -f HEAD~2 HEAD &&
-	git log -1 > actual &&
+	git log -1 >actual &&
 	test_cmp expect actual &&
 	test "$(git notes list HEAD)" = "$(git notes list HEAD~2)"
 '
 
 test_expect_success 'cannot copy note from object without notes' '
-	: > a12 &&
+	: >a12 &&
 	git add a12 &&
 	test_tick &&
 	git commit -m 12th &&
-	: > a13 &&
+	: >a13 &&
 	git add a13 &&
 	test_tick &&
 	git commit -m 13th &&
 	test_must_fail git notes copy HEAD^ HEAD
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit e5d4fb5698d564ab8c73551538ecaf2b0c666185
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:25:13 2005 -0700
@@ -1009,13 +1007,13 @@ test_expect_success 'git notes copy --stdin' '
 	(echo $(git rev-parse HEAD~3) $(git rev-parse HEAD^); \
 	echo $(git rev-parse HEAD~2) $(git rev-parse HEAD)) |
 	git notes copy --stdin &&
-	git log -2 > output &&
+	git log -2 >output &&
 	test_cmp expect output &&
 	test "$(git notes list HEAD)" = "$(git notes list HEAD~2)" &&
 	test "$(git notes list HEAD^)" = "$(git notes list HEAD~3)"
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:27:13 2005 -0700
@@ -1035,11 +1033,11 @@ test_expect_success 'git notes copy --for-rewrite (unconfigured)' '
 	(echo $(git rev-parse HEAD~3) $(git rev-parse HEAD^); \
 	echo $(git rev-parse HEAD~2) $(git rev-parse HEAD)) |
 	git notes copy --for-rewrite=foo &&
-	git log -2 > output &&
+	git log -2 >output &&
 	test_cmp expect output
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:27:13 2005 -0700
@@ -1069,7 +1067,7 @@ test_expect_success 'git notes copy --for-rewrite (enabled)' '
 	(echo $(git rev-parse HEAD~3) $(git rev-parse HEAD^); \
 	echo $(git rev-parse HEAD~2) $(git rev-parse HEAD)) |
 	git notes copy --for-rewrite=foo &&
-	git log -2 > output &&
+	git log -2 >output &&
 	test_cmp expect output
 '
 
@@ -1077,11 +1075,11 @@ test_expect_success 'git notes copy --for-rewrite (disabled)' '
 	git config notes.rewrite.bar false &&
 	echo $(git rev-parse HEAD~3) $(git rev-parse HEAD) |
 	git notes copy --for-rewrite=bar &&
-	git log -2 > output &&
+	git log -2 >output &&
 	test_cmp expect output
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:27:13 2005 -0700
@@ -1096,7 +1094,7 @@ test_expect_success 'git notes copy --for-rewrite (overwrite)' '
 	git notes add -f -m"a fresh note" HEAD^ &&
 	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
 	git notes copy --for-rewrite=foo &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect output
 '
 
@@ -1104,11 +1102,11 @@ test_expect_success 'git notes copy --for-rewrite (ignore)' '
 	git config notes.rewriteMode ignore &&
 	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
 	git notes copy --for-rewrite=foo &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect output
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:27:13 2005 -0700
@@ -1126,11 +1124,11 @@ test_expect_success 'git notes copy --for-rewrite (append)' '
 	git config notes.rewriteMode concatenate &&
 	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
 	git notes copy --for-rewrite=foo &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect output
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:27:13 2005 -0700
@@ -1153,7 +1151,7 @@ test_expect_success 'git notes copy --for-rewrite (append two to one)' '
 	(echo $(git rev-parse HEAD^) $(git rev-parse HEAD);
 	echo $(git rev-parse HEAD^^) $(git rev-parse HEAD)) |
 	git notes copy --for-rewrite=foo &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect output
 '
 
@@ -1161,11 +1159,11 @@ test_expect_success 'git notes copy --for-rewrite (append empty)' '
 	git notes remove HEAD^ &&
 	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
 	git notes copy --for-rewrite=foo &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect output
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:27:13 2005 -0700
@@ -1180,11 +1178,11 @@ test_expect_success 'GIT_NOTES_REWRITE_MODE works' '
 	git notes add -f -m"replacement note 1" HEAD^ &&
 	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
 	GIT_NOTES_REWRITE_MODE=overwrite git notes copy --for-rewrite=foo &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect output
 '
 
-cat > expect << EOF
+cat >expect <<EOF
 commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
 Author: A U Thor <author@example.com>
 Date:   Thu Apr 7 15:27:13 2005 -0700
@@ -1202,7 +1200,7 @@ test_expect_success 'GIT_NOTES_REWRITE_REF works' '
 	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
 	GIT_NOTES_REWRITE_REF=refs/notes/commits:refs/notes/other \
 		git notes copy --for-rewrite=foo &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect output
 '
 
@@ -1211,7 +1209,7 @@ test_expect_success 'GIT_NOTES_REWRITE_REF overrides config' '
 	git notes add -f -m"replacement note 3" HEAD^ &&
 	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
 	GIT_NOTES_REWRITE_REF= git notes copy --for-rewrite=foo &&
-	git log -1 > output &&
+	git log -1 >output &&
 	test_cmp expect output
 '
 
-- 
2.0.0.rc4.501.gdaf83ca

Re: [PATCHv3 2/5] t3301: Verify that 'git notes' removes empty notes by default

[Junio C Hamano]

Johan Herland <johan@herland.net> writes:

> 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.
>
> Improved-by: Eric Sunshine <sunshine@sunshineco.com>
> Improved-by: Junio C Hamano <gitster@pobox.com>
> Signed-off-by: Johan Herland <johan@herland.net>
> ---
>  t/t3301-notes.sh | 27 +++++++++++++++++++++++++++
>  1 file changed, 27 insertions(+)
>
> diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
> index cfd67ff..33f0558 100755
> --- a/t/t3301-notes.sh
> +++ b/t/t3301-notes.sh
> @@ -1239,4 +1239,31 @@ test_expect_success 'git notes get-ref (--ref)' '
>  	test "$(GIT_NOTES_REF=refs/notes/bar git notes --ref=baz get-ref)" = "refs/notes/baz"
>  '
>  
> +test_expect_success 'setup testing of empty notes' '
> +	git config --unset core.notesRef &&

Use "test_unconfig" instead?

If the previous test failed (or a different topic that touches this
same script is merged to change what the previous test leaves), this
configuration variable may not be set, and "config --unset" may
fail.

> +	test_commit 16th &&
> +	empty_blob=$(git hash-object -w /dev/null)
> +'
> +
> +while read cmd
> +do
> +	test_expect_success "'git notes $cmd' removes empty note" "
> +		test_might_fail git notes remove HEAD &&
> +		MSG= git notes $cmd &&
> +		test_must_fail git notes list HEAD
> +	"
> +done <<\EOF
> +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
> +EOF
> +
>  test_done

Re: [PATCHv3 3/5] builtin/notes: Add --allow-empty, to allow storing empty notes

[Junio C Hamano]

Johan Herland <johan@herland.net> writes:

> 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>
> ---

Assuming that it is a good idea to "allow" empty notes, I think
there are two issues involved here:

 * Traditionally, feeding an empty note is taken as a request to
   remove an existing note.  Therefore, there is no way to
   explicitly ask an empty note to be stored for a commit.

 * Because feeding an empty note was the way to request removal,
   even though "git notes remove" is there, it is underused.

In other words, assuming that it is a good idea to allow empty
notes, isn't the desired endgame, after compatibility transition
period, that "git notes add" will never remove notes?

With that endgame in mind, shouldn't the internal implementation be
moving in a direction where "create_note()" will *not* be doing any
removal, and its caller (i.e. "add") does the switching depending on
the "do we take emptyness as a request to remove"?  I.e.

         static int add(...)
         {
		if (!allow_empty && message_is_empty())
                	remove_note();
		else
                	create_note();
	}

>  static void create_note(const unsigned char *object, struct msg_arg *msg,
> -			int append_only, const unsigned char *prev,
> -			unsigned char *result)
> +			int append_only, int allow_empty,
> +			const unsigned char *prev, unsigned char *result)

In other words, I have this suspicion that create_note() that 
removes is a wrong interface in the first place, and giving it
a new allow_empty parameter to conditionally perform removal is
making it worse.  No?

Re: [PATCHv3 4/5] notes: Empty notes should be shown by 'git log'

[Junio C Hamano]

Johan Herland <johan@herland.net> writes:

> If the user has gone through the trouble of explicitly adding an empty
> note, then "git log" should not silently skip it (as if it didn't exist).
>
> Signed-off-by: Johan Herland <johan@herland.net>
> ---

This makes sense and is in line with the theme of this series.

>  notes.c          |  3 +--
>  t/t3301-notes.sh | 12 ++++++++++++
>  2 files changed, 13 insertions(+), 2 deletions(-)
>
> diff --git a/notes.c b/notes.c
> index 5fe691d..62bc6e1 100644
> --- a/notes.c
> +++ b/notes.c
> @@ -1218,8 +1218,7 @@ static void format_note(struct notes_tree *t, const unsigned char *object_sha1,
>  	if (!sha1)
>  		return;
>  
> -	if (!(msg = read_sha1_file(sha1, &type, &msglen)) || !msglen ||
> -			type != OBJ_BLOB) {
> +	if (!(msg = read_sha1_file(sha1, &type, &msglen)) || type != OBJ_BLOB) {
>  		free(msg);
>  		return;
>  	}
> diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
> index 8280a1a..f5d8193 100755
> --- a/t/t3301-notes.sh
> +++ b/t/t3301-notes.sh
> @@ -1274,4 +1274,16 @@ append -C "$empty_blob"
>  edit
>  EOF
>  
> +test_expect_success 'empty notes are displayed by git log' '
> +	test_commit 17th &&
> +	git log -1 >expect &&
> +	cat >>expect <<\EOF &&
> +
> +Notes:
> +EOF
> +	git notes add -C "$empty_blob" --allow-empty &&
> +	git log -1 >actual &&
> +	test_cmp expect actual
> +'
> +
>  test_done

Re: [PATCHv3 5/5] t3301: Use write_script(), nitpick whitespace

[Junio C Hamano]

Johan Herland <johan@herland.net> writes:

> Signed-off-by: Johan Herland <johan@herland.net>
> ---
>
> Drop this if it's too much churn.

This is an overdue clean-up and because nobody else is working in
the area, it is good to do so either as a preliminary clean-up or as
a after-the-dust-settles clean-up for this series.

These whitespace issues are not the only ones in this script that
need modernizing, though.  Preparation of "expect" outside tests
makes this script look quite old fashioned, for example.

> ...Johan
>
>  t/t3301-notes.sh | 254 +++++++++++++++++++++++++++----------------------------
>  1 file changed, 126 insertions(+), 128 deletions(-)
>
> diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
> index f5d8193..80caee0 100755
> --- a/t/t3301-notes.sh
> +++ b/t/t3301-notes.sh
> @@ -7,13 +7,11 @@ test_description='Test commit notes'
>  
>  . ./test-lib.sh
>  
> -cat > fake_editor.sh << \EOF
> -#!/bin/sh
> -echo "$MSG" > "$1"
> -echo "$MSG" >& 2
> +write_script fake_editor <<\EOF
> +echo "$MSG" >"$1"
> +echo "$MSG" >&2
>  EOF
> -chmod a+x fake_editor.sh
> -GIT_EDITOR=./fake_editor.sh
> +GIT_EDITOR=./fake_editor
>  export GIT_EDITOR
>  
>  test_expect_success 'cannot annotate non-existing HEAD' '
> @@ -21,11 +19,11 @@ test_expect_success 'cannot annotate non-existing HEAD' '
>  '
>  
>  test_expect_success setup '
> -	: > a1 &&
> +	: >a1 &&
>  	git add a1 &&
>  	test_tick &&
>  	git commit -m 1st &&
> -	: > a2 &&
> +	: >a2 &&
>  	git add a2 &&
>  	test_tick &&
>  	git commit -m 2nd
> @@ -131,7 +129,7 @@ test_expect_success 'can overwrite existing note with "git notes add -f"' '
>  	test_must_fail git notes show HEAD^
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 268048bfb8a1fb38e703baceb8ab235421bf80c5
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:14:13 2005 -0700
> @@ -144,12 +142,12 @@ EOF
>  
>  test_expect_success 'show notes' '
>  	! (git cat-file commit HEAD | grep b1) &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect output
>  '
>  
>  test_expect_success 'create multi-line notes (setup)' '
> -	: > a3 &&
> +	: >a3 &&
>  	git add a3 &&
>  	test_tick &&
>  	git commit -m 3rd &&
> @@ -158,7 +156,7 @@ c3c3c3c3
>  d3d3d3" git notes add
>  '
>  
> -cat > expect-multiline << EOF
> +cat >expect-multiline <<EOF
>  commit 1584215f1d29c65e99c6c6848626553fdd07fd75
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:15:13 2005 -0700
> @@ -171,23 +169,23 @@ Notes:
>      d3d3d3
>  EOF
>  
> -printf "\n" >> expect-multiline
> -cat expect >> expect-multiline
> +printf "\n" >>expect-multiline
> +cat expect >>expect-multiline
>  
>  test_expect_success 'show multi-line notes' '
> -	git log -2 > output &&
> +	git log -2 >output &&
>  	test_cmp expect-multiline output
>  '
>  test_expect_success 'create -F notes (setup)' '
> -	: > a4 &&
> +	: >a4 &&
>  	git add a4 &&
>  	test_tick &&
>  	git commit -m 4th &&
> -	echo "xyzzy" > note5 &&
> +	echo "xyzzy" >note5 &&
>  	git notes add -F note5
>  '
>  
> -cat > expect-F << EOF
> +cat >expect-F <<EOF
>  commit 15023535574ded8b1a89052b32673f84cf9582b8
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:16:13 2005 -0700
> @@ -198,22 +196,22 @@ Notes:
>      xyzzy
>  EOF
>  
> -printf "\n" >> expect-F
> -cat expect-multiline >> expect-F
> +printf "\n" >>expect-F
> +cat expect-multiline >>expect-F
>  
>  test_expect_success 'show -F notes' '
> -	git log -3 > output &&
> +	git log -3 >output &&
>  	test_cmp expect-F output
>  '
>  
>  test_expect_success 'Re-adding -F notes without -f fails' '
> -	echo "zyxxy" > note5 &&
> +	echo "zyxxy" >note5 &&
>  	test_must_fail git notes add -F note5 &&
> -	git log -3 > output &&
> +	git log -3 >output &&
>  	test_cmp expect-F output
>  '
>  
> -cat >expect << EOF
> +cat >expect <<EOF
>  commit 15023535574ded8b1a89052b32673f84cf9582b8
>  tree e070e3af51011e47b183c33adf9736736a525709
>  parent 1584215f1d29c65e99c6c6848626553fdd07fd75
> @@ -305,7 +303,7 @@ test_expect_success 'git log --no-notes resets ref list' '
>  '
>  
>  test_expect_success 'create -m notes (setup)' '
> -	: > a5 &&
> +	: >a5 &&
>  	git add a5 &&
>  	test_tick &&
>  	git commit -m 5th &&
> @@ -315,7 +313,7 @@ baz"
>  '
>  
>  whitespace="    "
> -cat > expect-m << EOF
> +cat >expect-m <<EOF
>  commit bd1753200303d0a0344be813e504253b3d98e74d
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:17:13 2005 -0700
> @@ -330,11 +328,11 @@ $whitespace
>      baz
>  EOF
>  
> -printf "\n" >> expect-m
> -cat expect-F >> expect-m
> +printf "\n" >>expect-m
> +cat expect-F >>expect-m
>  
>  test_expect_success 'show -m notes' '
> -	git log -4 > output &&
> +	git log -4 >output &&
>  	test_cmp expect-m output
>  '
>  
> @@ -342,7 +340,7 @@ test_expect_success 'remove note with add -f -F /dev/null (setup)' '
>  	git notes add -f -F /dev/null
>  '
>  
> -cat > expect-rm-F << EOF
> +cat >expect-rm-F <<EOF
>  commit bd1753200303d0a0344be813e504253b3d98e74d
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:17:13 2005 -0700
> @@ -350,11 +348,11 @@ Date:   Thu Apr 7 15:17:13 2005 -0700
>      5th
>  EOF
>  
> -printf "\n" >> expect-rm-F
> -cat expect-F >> expect-rm-F
> +printf "\n" >>expect-rm-F
> +cat expect-F >>expect-rm-F
>  
>  test_expect_success 'verify note removal with -F /dev/null' '
> -	git log -4 > output &&
> +	git log -4 >output &&
>  	test_cmp expect-rm-F output &&
>  	test_must_fail git notes show
>  '
> @@ -364,12 +362,12 @@ test_expect_success 'do not create empty note with -m "" (setup)' '
>  '
>  
>  test_expect_success 'verify non-creation of note with -m ""' '
> -	git log -4 > output &&
> +	git log -4 >output &&
>  	test_cmp expect-rm-F output &&
>  	test_must_fail git notes show
>  '
>  
> -cat > expect-combine_m_and_F << EOF
> +cat >expect-combine_m_and_F <<EOF
>  foo
>  
>  xyzzy
> @@ -382,10 +380,10 @@ baz
>  EOF
>  
>  test_expect_success 'create note with combination of -m and -F' '
> -	echo "xyzzy" > note_a &&
> -	echo "zyxxy" > note_b &&
> +	echo "xyzzy" >note_a &&
> +	echo "zyxxy" >note_b &&
>  	git notes add -m "foo" -F note_a -m "bar" -F note_b -m "baz" &&
> -	git notes show > output &&
> +	git notes show >output &&
>  	test_cmp expect-combine_m_and_F output
>  '
>  
> @@ -394,7 +392,7 @@ test_expect_success 'remove note with "git notes remove" (setup)' '
>  	git notes remove
>  '
>  
> -cat > expect-rm-remove << EOF
> +cat >expect-rm-remove <<EOF
>  commit bd1753200303d0a0344be813e504253b3d98e74d
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:17:13 2005 -0700
> @@ -408,24 +406,24 @@ Date:   Thu Apr 7 15:16:13 2005 -0700
>      4th
>  EOF
>  
> -printf "\n" >> expect-rm-remove
> -cat expect-multiline >> expect-rm-remove
> +printf "\n" >>expect-rm-remove
> +cat expect-multiline >>expect-rm-remove
>  
>  test_expect_success 'verify note removal with "git notes remove"' '
> -	git log -4 > output &&
> +	git log -4 >output &&
>  	test_cmp expect-rm-remove output &&
>  	test_must_fail git notes show HEAD^
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  c18dc024e14f08d18d14eea0d747ff692d66d6a3 1584215f1d29c65e99c6c6848626553fdd07fd75
>  c9c6af7f78bc47490dbf3e822cf2f3c24d4b9061 268048bfb8a1fb38e703baceb8ab235421bf80c5
>  EOF
>  
>  test_expect_success 'removing non-existing note should not create new commit' '
> -	git rev-parse --verify refs/notes/commits > before_commit &&
> +	git rev-parse --verify refs/notes/commits >before_commit &&
>  	test_must_fail git notes remove HEAD^ &&
> -	git rev-parse --verify refs/notes/commits > after_commit &&
> +	git rev-parse --verify refs/notes/commits >after_commit &&
>  	test_cmp before_commit after_commit
>  '
>  
> @@ -505,33 +503,33 @@ test_expect_success 'removing with --stdin --ignore-missing' '
>  '
>  
>  test_expect_success 'list notes with "git notes list"' '
> -	git notes list > output &&
> +	git notes list >output &&
>  	test_cmp expect output
>  '
>  
>  test_expect_success 'list notes with "git notes"' '
> -	git notes > output &&
> +	git notes >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  c18dc024e14f08d18d14eea0d747ff692d66d6a3
>  EOF
>  
>  test_expect_success 'list specific note with "git notes list <object>"' '
> -	git notes list HEAD^^ > output &&
> +	git notes list HEAD^^ >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  EOF
>  
>  test_expect_success 'listing non-existing notes fails' '
> -	test_must_fail git notes list HEAD > output &&
> +	test_must_fail git notes list HEAD >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  Initial set of notes
>  
>  More notes appended with git notes append
> @@ -540,24 +538,24 @@ EOF
>  test_expect_success 'append to existing note with "git notes append"' '
>  	git notes add -m "Initial set of notes" &&
>  	git notes append -m "More notes appended with git notes append" &&
> -	git notes show > output &&
> +	git notes show >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect_list << EOF
> +cat >expect_list <<EOF
>  c18dc024e14f08d18d14eea0d747ff692d66d6a3 1584215f1d29c65e99c6c6848626553fdd07fd75
>  c9c6af7f78bc47490dbf3e822cf2f3c24d4b9061 268048bfb8a1fb38e703baceb8ab235421bf80c5
>  4b6ad22357cc8a1296720574b8d2fbc22fab0671 bd1753200303d0a0344be813e504253b3d98e74d
>  EOF
>  
>  test_expect_success '"git notes list" does not expand to "git notes list HEAD"' '
> -	git notes list > output &&
> +	git notes list >output &&
>  	test_cmp expect_list output
>  '
>  
>  test_expect_success 'appending empty string does not change existing note' '
>  	git notes append -m "" &&
> -	git notes show > output &&
> +	git notes show >output &&
>  	test_cmp expect output
>  '
>  
> @@ -567,7 +565,7 @@ test_expect_success 'git notes append == add when there is no existing note' '
>  	git notes append -m "Initial set of notes
>  
>  More notes appended with git notes append" &&
> -	git notes show > output &&
> +	git notes show >output &&
>  	test_cmp expect output
>  '
>  
> @@ -579,14 +577,14 @@ test_expect_success 'appending empty string to non-existing note does not create
>  '
>  
>  test_expect_success 'create other note on a different notes ref (setup)' '
> -	: > a6 &&
> +	: >a6 &&
>  	git add a6 &&
>  	test_tick &&
>  	git commit -m 6th &&
>  	GIT_NOTES_REF="refs/notes/other" git notes add -m "other note"
>  '
>  
> -cat > expect-other << EOF
> +cat >expect-other <<EOF
>  commit 387a89921c73d7ed72cd94d179c1c7048ca47756
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:18:13 2005 -0700
> @@ -597,7 +595,7 @@ Notes (other):
>      other note
>  EOF
>  
> -cat > expect-not-other << EOF
> +cat >expect-not-other <<EOF
>  commit 387a89921c73d7ed72cd94d179c1c7048ca47756
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:18:13 2005 -0700
> @@ -606,27 +604,27 @@ Date:   Thu Apr 7 15:18:13 2005 -0700
>  EOF
>  
>  test_expect_success 'Do not show note on other ref by default' '
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect-not-other output
>  '
>  
>  test_expect_success 'Do show note when ref is given in GIT_NOTES_REF' '
> -	GIT_NOTES_REF="refs/notes/other" git log -1 > output &&
> +	GIT_NOTES_REF="refs/notes/other" git log -1 >output &&
>  	test_cmp expect-other output
>  '
>  
>  test_expect_success 'Do show note when ref is given in core.notesRef config' '
>  	git config core.notesRef "refs/notes/other" &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect-other output
>  '
>  
>  test_expect_success 'Do not show note when core.notesRef is overridden' '
> -	GIT_NOTES_REF="refs/notes/wrong" git log -1 > output &&
> +	GIT_NOTES_REF="refs/notes/wrong" git log -1 >output &&
>  	test_cmp expect-not-other output
>  '
>  
> -cat > expect-both << EOF
> +cat >expect-both <<EOF
>  commit 387a89921c73d7ed72cd94d179c1c7048ca47756
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:18:13 2005 -0700
> @@ -655,14 +653,14 @@ test_expect_success 'Show all notes when notes.displayRef=refs/notes/*' '
>  	GIT_NOTES_REF=refs/notes/commits git notes add -m"order test" &&
>  	git config --unset core.notesRef &&
>  	git config notes.displayRef "refs/notes/*" &&
> -	git log -2 > output &&
> +	git log -2 >output &&
>  	test_cmp expect-both output
>  '
>  
>  test_expect_success 'core.notesRef is implicitly in notes.displayRef' '
>  	git config core.notesRef refs/notes/commits &&
>  	git config notes.displayRef refs/notes/other &&
> -	git log -2 > output &&
> +	git log -2 >output &&
>  	test_cmp expect-both output
>  '
>  
> @@ -670,11 +668,11 @@ test_expect_success 'notes.displayRef can be given more than once' '
>  	git config --unset core.notesRef &&
>  	git config notes.displayRef refs/notes/commits &&
>  	git config --add notes.displayRef refs/notes/other &&
> -	git log -2 > output &&
> +	git log -2 >output &&
>  	test_cmp expect-both output
>  '
>  
> -cat > expect-both-reversed << EOF
> +cat >expect-both-reversed <<EOF
>  commit 387a89921c73d7ed72cd94d179c1c7048ca47756
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:18:13 2005 -0700
> @@ -692,7 +690,7 @@ test_expect_success 'notes.displayRef respects order' '
>  	git config core.notesRef refs/notes/other &&
>  	git config --unset-all notes.displayRef &&
>  	git config notes.displayRef refs/notes/commits &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect-both-reversed output
>  '
>  
> @@ -700,11 +698,11 @@ test_expect_success 'GIT_NOTES_DISPLAY_REF works' '
>  	git config --unset-all core.notesRef &&
>  	git config --unset-all notes.displayRef &&
>  	GIT_NOTES_DISPLAY_REF=refs/notes/commits:refs/notes/other \
> -		git log -2 > output &&
> +		git log -2 >output &&
>  	test_cmp expect-both output
>  '
>  
> -cat > expect-none << EOF
> +cat >expect-none <<EOF
>  commit 387a89921c73d7ed72cd94d179c1c7048ca47756
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:18:13 2005 -0700
> @@ -720,16 +718,16 @@ EOF
>  
>  test_expect_success 'GIT_NOTES_DISPLAY_REF overrides config' '
>  	git config notes.displayRef "refs/notes/*" &&
> -	GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log -2 > output &&
> +	GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log -2 >output &&
>  	test_cmp expect-none output
>  '
>  
>  test_expect_success '--show-notes=* adds to GIT_NOTES_DISPLAY_REF' '
> -	GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log --show-notes=* -2 > output &&
> +	GIT_NOTES_REF= GIT_NOTES_DISPLAY_REF= git log --show-notes=* -2 >output &&
>  	test_cmp expect-both output
>  '
>  
> -cat > expect-commits << EOF
> +cat >expect-commits <<EOF
>  commit 387a89921c73d7ed72cd94d179c1c7048ca47756
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:18:13 2005 -0700
> @@ -741,41 +739,41 @@ Notes:
>  EOF
>  
>  test_expect_success '--no-standard-notes' '
> -	git log --no-standard-notes --show-notes=commits -1 > output &&
> +	git log --no-standard-notes --show-notes=commits -1 >output &&
>  	test_cmp expect-commits output
>  '
>  
>  test_expect_success '--standard-notes' '
>  	git log --no-standard-notes --show-notes=commits \
> -		--standard-notes -2 > output &&
> +		--standard-notes -2 >output &&
>  	test_cmp expect-both output
>  '
>  
>  test_expect_success '--show-notes=ref accumulates' '
>  	git log --show-notes=other --show-notes=commits \
> -		 --no-standard-notes -1 > output &&
> +		 --no-standard-notes -1 >output &&
>  	test_cmp expect-both-reversed output
>  '
>  
>  test_expect_success 'Allow notes on non-commits (trees, blobs, tags)' '
>  	git config core.notesRef refs/notes/other &&
> -	echo "Note on a tree" > expect &&
> +	echo "Note on a tree" >expect &&
>  	git notes add -m "Note on a tree" HEAD: &&
> -	git notes show HEAD: > actual &&
> +	git notes show HEAD: >actual &&
>  	test_cmp expect actual &&
> -	echo "Note on a blob" > expect &&
> +	echo "Note on a blob" >expect &&
>  	filename=$(git ls-tree --name-only HEAD | head -n1) &&
>  	git notes add -m "Note on a blob" HEAD:$filename &&
> -	git notes show HEAD:$filename > actual &&
> +	git notes show HEAD:$filename >actual &&
>  	test_cmp expect actual &&
> -	echo "Note on a tag" > expect &&
> +	echo "Note on a tag" >expect &&
>  	git tag -a -m "This is an annotated tag" foobar HEAD^ &&
>  	git notes add -m "Note on a tag" foobar &&
> -	git notes show foobar > actual &&
> +	git notes show foobar >actual &&
>  	test_cmp expect actual
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 2ede89468182a62d0bde2583c736089bcf7d7e92
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:19:13 2005 -0700
> @@ -787,18 +785,18 @@ Notes (other):
>  EOF
>  
>  test_expect_success 'create note from other note with "git notes add -C"' '
> -	: > a7 &&
> +	: >a7 &&
>  	git add a7 &&
>  	test_tick &&
>  	git commit -m 7th &&
>  	git notes add -C $(git notes list HEAD^) &&
> -	git log -1 > actual &&
> +	git log -1 >actual &&
>  	test_cmp expect actual &&
>  	test "$(git notes list HEAD)" = "$(git notes list HEAD^)"
>  '
>  
>  test_expect_success 'create note from non-existing note with "git notes add -C" fails' '
> -	: > a8 &&
> +	: >a8 &&
>  	git add a8 &&
>  	test_tick &&
>  	git commit -m 8th &&
> @@ -814,7 +812,7 @@ test_expect_success 'create note from non-blob with "git notes add -C" fails' '
>  	test_must_fail git notes list HEAD
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 80d796defacd5db327b7a4e50099663902fbdc5c
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:20:13 2005 -0700
> @@ -828,12 +826,12 @@ EOF
>  test_expect_success 'create note from blob with "git notes add -C" reuses blob id' '
>  	blob=$(echo "This is a blob object" | git hash-object -w --stdin) &&
>  	git notes add -C $blob &&
> -	git log -1 > actual &&
> +	git log -1 >actual &&
>  	test_cmp expect actual &&
>  	test "$(git notes list HEAD)" = "$blob"
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 016e982bad97eacdbda0fcbd7ce5b0ba87c81f1b
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:21:13 2005 -0700
> @@ -845,17 +843,17 @@ Notes (other):
>  EOF
>  
>  test_expect_success 'create note from other note with "git notes add -c"' '
> -	: > a9 &&
> +	: >a9 &&
>  	git add a9 &&
>  	test_tick &&
>  	git commit -m 9th &&
>  	MSG="yet another note" git notes add -c $(git notes list HEAD^^) &&
> -	git log -1 > actual &&
> +	git log -1 >actual &&
>  	test_cmp expect actual
>  '
>  
>  test_expect_success 'create note from non-existing note with "git notes add -c" fails' '
> -	: > a10 &&
> +	: >a10 &&
>  	git add a10 &&
>  	test_tick &&
>  	git commit -m 10th &&
> @@ -863,7 +861,7 @@ test_expect_success 'create note from non-existing note with "git notes add -c"
>  	test_must_fail git notes list HEAD
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 016e982bad97eacdbda0fcbd7ce5b0ba87c81f1b
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:21:13 2005 -0700
> @@ -878,11 +876,11 @@ EOF
>  
>  test_expect_success 'append to note from other note with "git notes append -C"' '
>  	git notes append -C $(git notes list HEAD^) HEAD^ &&
> -	git log -1 HEAD^ > actual &&
> +	git log -1 HEAD^ >actual &&
>  	test_cmp expect actual
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit ffed603236bfa3891c49644257a83598afe8ae5a
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:22:13 2005 -0700
> @@ -895,11 +893,11 @@ EOF
>  
>  test_expect_success 'create note from other note with "git notes append -c"' '
>  	MSG="other note" git notes append -c $(git notes list HEAD^) &&
> -	git log -1 > actual &&
> +	git log -1 >actual &&
>  	test_cmp expect actual
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit ffed603236bfa3891c49644257a83598afe8ae5a
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:22:13 2005 -0700
> @@ -914,11 +912,11 @@ EOF
>  
>  test_expect_success 'append to note from other note with "git notes append -c"' '
>  	MSG="yet another note" git notes append -c $(git notes list HEAD) &&
> -	git log -1 > actual &&
> +	git log -1 >actual &&
>  	test_cmp expect actual
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 6352c5e33dbcab725fe0579be16aa2ba8eb369be
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:23:13 2005 -0700
> @@ -932,24 +930,24 @@ $whitespace
>  EOF
>  
>  test_expect_success 'copy note with "git notes copy"' '
> -	: > a11 &&
> +	: >a11 &&
>  	git add a11 &&
>  	test_tick &&
>  	git commit -m 11th &&
>  	git notes copy HEAD^ HEAD &&
> -	git log -1 > actual &&
> +	git log -1 >actual &&
>  	test_cmp expect actual &&
>  	test "$(git notes list HEAD)" = "$(git notes list HEAD^)"
>  '
>  
>  test_expect_success 'prevent overwrite with "git notes copy"' '
>  	test_must_fail git notes copy HEAD~2 HEAD &&
> -	git log -1 > actual &&
> +	git log -1 >actual &&
>  	test_cmp expect actual &&
>  	test "$(git notes list HEAD)" = "$(git notes list HEAD^)"
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 6352c5e33dbcab725fe0579be16aa2ba8eb369be
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:23:13 2005 -0700
> @@ -964,24 +962,24 @@ EOF
>  
>  test_expect_success 'allow overwrite with "git notes copy -f"' '
>  	git notes copy -f HEAD~2 HEAD &&
> -	git log -1 > actual &&
> +	git log -1 >actual &&
>  	test_cmp expect actual &&
>  	test "$(git notes list HEAD)" = "$(git notes list HEAD~2)"
>  '
>  
>  test_expect_success 'cannot copy note from object without notes' '
> -	: > a12 &&
> +	: >a12 &&
>  	git add a12 &&
>  	test_tick &&
>  	git commit -m 12th &&
> -	: > a13 &&
> +	: >a13 &&
>  	git add a13 &&
>  	test_tick &&
>  	git commit -m 13th &&
>  	test_must_fail git notes copy HEAD^ HEAD
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit e5d4fb5698d564ab8c73551538ecaf2b0c666185
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:25:13 2005 -0700
> @@ -1009,13 +1007,13 @@ test_expect_success 'git notes copy --stdin' '
>  	(echo $(git rev-parse HEAD~3) $(git rev-parse HEAD^); \
>  	echo $(git rev-parse HEAD~2) $(git rev-parse HEAD)) |
>  	git notes copy --stdin &&
> -	git log -2 > output &&
> +	git log -2 >output &&
>  	test_cmp expect output &&
>  	test "$(git notes list HEAD)" = "$(git notes list HEAD~2)" &&
>  	test "$(git notes list HEAD^)" = "$(git notes list HEAD~3)"
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:27:13 2005 -0700
> @@ -1035,11 +1033,11 @@ test_expect_success 'git notes copy --for-rewrite (unconfigured)' '
>  	(echo $(git rev-parse HEAD~3) $(git rev-parse HEAD^); \
>  	echo $(git rev-parse HEAD~2) $(git rev-parse HEAD)) |
>  	git notes copy --for-rewrite=foo &&
> -	git log -2 > output &&
> +	git log -2 >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:27:13 2005 -0700
> @@ -1069,7 +1067,7 @@ test_expect_success 'git notes copy --for-rewrite (enabled)' '
>  	(echo $(git rev-parse HEAD~3) $(git rev-parse HEAD^); \
>  	echo $(git rev-parse HEAD~2) $(git rev-parse HEAD)) |
>  	git notes copy --for-rewrite=foo &&
> -	git log -2 > output &&
> +	git log -2 >output &&
>  	test_cmp expect output
>  '
>  
> @@ -1077,11 +1075,11 @@ test_expect_success 'git notes copy --for-rewrite (disabled)' '
>  	git config notes.rewrite.bar false &&
>  	echo $(git rev-parse HEAD~3) $(git rev-parse HEAD) |
>  	git notes copy --for-rewrite=bar &&
> -	git log -2 > output &&
> +	git log -2 >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:27:13 2005 -0700
> @@ -1096,7 +1094,7 @@ test_expect_success 'git notes copy --for-rewrite (overwrite)' '
>  	git notes add -f -m"a fresh note" HEAD^ &&
>  	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
>  	git notes copy --for-rewrite=foo &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect output
>  '
>  
> @@ -1104,11 +1102,11 @@ test_expect_success 'git notes copy --for-rewrite (ignore)' '
>  	git config notes.rewriteMode ignore &&
>  	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
>  	git notes copy --for-rewrite=foo &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:27:13 2005 -0700
> @@ -1126,11 +1124,11 @@ test_expect_success 'git notes copy --for-rewrite (append)' '
>  	git config notes.rewriteMode concatenate &&
>  	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
>  	git notes copy --for-rewrite=foo &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:27:13 2005 -0700
> @@ -1153,7 +1151,7 @@ test_expect_success 'git notes copy --for-rewrite (append two to one)' '
>  	(echo $(git rev-parse HEAD^) $(git rev-parse HEAD);
>  	echo $(git rev-parse HEAD^^) $(git rev-parse HEAD)) |
>  	git notes copy --for-rewrite=foo &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect output
>  '
>  
> @@ -1161,11 +1159,11 @@ test_expect_success 'git notes copy --for-rewrite (append empty)' '
>  	git notes remove HEAD^ &&
>  	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
>  	git notes copy --for-rewrite=foo &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:27:13 2005 -0700
> @@ -1180,11 +1178,11 @@ test_expect_success 'GIT_NOTES_REWRITE_MODE works' '
>  	git notes add -f -m"replacement note 1" HEAD^ &&
>  	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
>  	GIT_NOTES_REWRITE_MODE=overwrite git notes copy --for-rewrite=foo &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect output
>  '
>  
> -cat > expect << EOF
> +cat >expect <<EOF
>  commit 37a0d4cba38afef96ba54a3ea567e6dac575700b
>  Author: A U Thor <author@example.com>
>  Date:   Thu Apr 7 15:27:13 2005 -0700
> @@ -1202,7 +1200,7 @@ test_expect_success 'GIT_NOTES_REWRITE_REF works' '
>  	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
>  	GIT_NOTES_REWRITE_REF=refs/notes/commits:refs/notes/other \
>  		git notes copy --for-rewrite=foo &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect output
>  '
>  
> @@ -1211,7 +1209,7 @@ test_expect_success 'GIT_NOTES_REWRITE_REF overrides config' '
>  	git notes add -f -m"replacement note 3" HEAD^ &&
>  	echo $(git rev-parse HEAD^) $(git rev-parse HEAD) |
>  	GIT_NOTES_REWRITE_REF= git notes copy --for-rewrite=foo &&
> -	git log -1 > output &&
> +	git log -1 >output &&
>  	test_cmp expect output
>  '

Re: [PATCHv3 3/5] builtin/notes: Add --allow-empty, to allow storing empty notes

[Johan Herland]

On Fri, Nov 7, 2014 at 7:04 PM, Junio C Hamano <gitster@pobox.com> wrote:
> Johan Herland <johan@herland.net> writes:

[...]

> Assuming that it is a good idea to "allow" empty notes, I think
> there are two issues involved here:
>
>  * Traditionally, feeding an empty note is taken as a request to
>    remove an existing note.  Therefore, there is no way to
>    explicitly ask an empty note to be stored for a commit.
>
>  * Because feeding an empty note was the way to request removal,
>    even though "git notes remove" is there, it is underused.
>
> In other words, assuming that it is a good idea to allow empty
> notes, isn't the desired endgame, after compatibility transition
> period, that "git notes add" will never remove notes?
>
> With that endgame in mind, shouldn't the internal implementation be
> moving in a direction where "create_note()" will *not* be doing any
> removal, and its caller (i.e. "add") does the switching depending on
> the "do we take emptyness as a request to remove"?  I.e.
>
>          static int add(...)
>          {
>                 if (!allow_empty && message_is_empty())
>                         remove_note();
>                 else
>                         create_note();
>         }
>
>>  static void create_note(const unsigned char *object, struct msg_arg *msg,
>> -                     int append_only, const unsigned char *prev,
>> -                     unsigned char *result)
>> +                     int append_only, int allow_empty,
>> +                     const unsigned char *prev, unsigned char *result)
>
> In other words, I have this suspicion that create_note() that
> removes is a wrong interface in the first place, and giving it
> a new allow_empty parameter to conditionally perform removal is
> making it worse.  No?

I agree, and it's fixed in the re-roll. It turned into a slightly
larger rewrite than anticipated, but I'm fairly happy with the result.


...Johan

-- 
Johan Herland, <johan@herland.net>
www.herland.net

Re: [PATCHv3 3/5] builtin/notes: Add --allow-empty, to allow storing empty notes

[Junio C Hamano]

Johan Herland <johan@herland.net> writes:

> On Fri, Nov 7, 2014 at 7:04 PM, Junio C Hamano <gitster@pobox.com> wrote:
>
>> In other words, I have this suspicion that create_note() that
>> removes is a wrong interface in the first place, and giving it
>> a new allow_empty parameter to conditionally perform removal is
>> making it worse.  No?
>
> I agree, and it's fixed in the re-roll. It turned into a slightly
> larger rewrite than anticipated, but I'm fairly happy with the result.

;-)