git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCHv12 23/23] builtin-notes: Add "add" subcommand for appending to note objects

From
Johan Herland <johan@herland.net>
Date
Jan 27, 2010, 11:52 UTC
Message-ID
<1264593120-4428-24-git-send-email-johan@herland.net>
In-Reply-To
<1264593120-4428-1-git-send-email-johan@herland.net>
"git notes add" is identical to "git notes edit" except that instead of
editing existing notes contents, you can only append to it. This is
useful for quickly adding annotations like e.g.:
	git notes add -m "Acked-by: A U Thor <author@example.com>"

If there is no existing note to append to, "git notes add" is identical to "git notes edit" (i.e. it adds a new note).

The patch includes tests verifying correct behaviour of the new subcommand.
Suggested-by: Joey Hess <joey@kitenet.net>
Signed-off-by: Johan Herland <johan@herland.net>
---
 Documentation/git-notes.txt |    5 ++++-
 builtin-notes.c             |   34 +++++++++++++++++++++++++---------
 t/t3301-notes.sh            |   29 +++++++++++++++++++++++++++++
 3 files changed, 58 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 4d29d5f..3fe73e8 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'git notes' [list [<object>]]
-'git notes' edit [-F <file> | -m <msg>] [<object>]
+'git notes' (edit | add) [-F <file> | -m <msg>] [<object>]
 'git notes' show [<object>]
 'git notes' remove [<object>]
 'git notes' prune
@@ -44,6 +44,9 @@ list::
 edit::
 	Edit the notes for a given object (defaults to HEAD).
 
+add::
+	Append to the notes for a given object (defaults to HEAD).
+
 show::
 	Show the notes for a given object (defaults to HEAD).
 
diff --git a/builtin-notes.c b/builtin-notes.c
index a322642..4f570a4 100644
--- a/builtin-notes.c
+++ b/builtin-notes.c
@@ -18,7 +18,7 @@
 
 static const char * const git_notes_usage[] = {
 	"git notes [list [<object>]]",
-	"git notes edit [-m <msg> | -F <file>] [<object>]",
+	"git notes (edit | add) [-m <msg> | -F <file>] [<object>]",
 	"git notes show [<object>]",
 	"git notes remove [<object>]",
 	"git notes prune",
@@ -53,7 +53,7 @@ static void write_note_data(int fd, const unsigned char *sha1)
 
 static void create_note(const unsigned char *object,
 			struct strbuf *buf,
-			int skip_editor,
+			int skip_editor, int append_only,
 			const unsigned char *prev,
 			unsigned char *result)
 {
@@ -68,7 +68,7 @@ static void create_note(const unsigned char *object,
 		if (fd < 0)
 			die_errno("could not create file '%s'", path);
 
-		if (prev)
+		if (prev && !append_only)
 			write_note_data(fd, prev);
 		write_or_die(fd, note_template, strlen(note_template));
 
@@ -82,6 +82,20 @@ static void create_note(const unsigned char *object,
 
 	stripspace(buf, 1);
 
+	if (prev && append_only) {
+		/* Append buf to previous note contents */
+		unsigned long size;
+		enum object_type type;
+		char *prev_buf = read_sha1_file(prev, &type, &size);
+
+		strbuf_grow(buf, size + 1);
+		if (buf->len && prev_buf && size)
+			strbuf_insert(buf, 0, "\n", 1);
+		if (prev_buf && size)
+			strbuf_insert(buf, 0, prev_buf, size);
+		free(prev_buf);
+	}
+
 	if (!buf->len) {
 		fprintf(stderr, "Removing note for object %s\n",
 			sha1_to_hex(object));
@@ -169,7 +183,7 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 	const char *object_ref;
 	char logmsg[100];
 
-	int list = 0, edit = 0, show = 0, remove = 0, prune = 0;
+	int list = 0, edit = 0, add = 0, show = 0, remove = 0, prune = 0;
 	int given_object;
 	const char *msgfile = NULL;
 	struct msg_arg msg = { 0, STRBUF_INIT };
@@ -189,6 +203,8 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 		list = 1;
 	else if (argc && !strcmp(argv[0], "edit"))
 		edit = 1;
+	else if (argc && !strcmp(argv[0], "add"))
+		add = 1;
 	else if (argc && !strcmp(argv[0], "show"))
 		show = 1;
 	else if (argc && !strcmp(argv[0], "remove"))
@@ -198,10 +214,10 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 	else if (!argc)
 		list = 1; /* Default to 'list' if no other subcommand given */
 
-	if (list + edit + show + remove + prune != 1)
+	if (list + edit + add + show + remove + prune != 1)
 		usage_with_options(git_notes_usage, options);
 
-	if ((msg.given || msgfile) && !edit) {
+	if ((msg.given || msgfile) && !(edit || add)) {
 		error("cannot use -m/-F options with %s subcommand.", argv[0]);
 		usage_with_options(git_notes_usage, options);
 	}
@@ -250,7 +266,7 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 		return execv_git_cmd(show_args);
 	}
 
-	/* edit/remove/prune command */
+	/* edit/add/remove/prune command */
 
 	if (remove)
 		strbuf_reset(&buf);
@@ -268,8 +284,8 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 		hashclr(new_note);
 		prune_notes(t);
 	} else {
-		create_note(object, &buf, msg.given || msgfile || remove, note,
-			    new_note);
+		create_note(object, &buf, msg.given || msgfile || remove, add,
+			    note, new_note);
 		if (is_null_sha1(new_note))
 			remove_note(t, object);
 		else
diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
index 13f307a..b40e5a1 100755
--- a/t/t3301-notes.sh
+++ b/t/t3301-notes.sh
@@ -316,6 +316,35 @@ test_expect_success 'list specific note with "git notes list <object>"' '
 	test_cmp expect output
 '
 
+cat > expect << EOF
+Initial set of notes
+
+More notes added with git notes add
+EOF
+
+test_expect_success 'Append to existing note with "git notes add"' '
+	git notes edit -m "Initial set of notes" &&
+	git notes add -m "More notes added with git notes add" &&
+	git notes show > output &&
+	test_cmp expect output
+'
+
+test_expect_success 'Appending empty string does not change existing note' '
+	git notes add -m "" &&
+	git notes show > output &&
+	test_cmp expect output
+'
+
+test_expect_success 'git notes add == edit when there is no existing note' '
+	git notes remove HEAD &&
+	! git notes show &&
+	git notes add -m "Initial set of notes
+
+More notes added with git notes add" &&
+	git notes show > output &&
+	test_cmp expect output
+'
+
 test_expect_success 'create other note on a different notes ref (setup)' '
 	: > a6 &&
 	git add a6 &&

-- 
1.6.6.405.g80ed6
Previous: Johan HerlandNext: Junio C Hamano
Message 26 of 31 in “[PATCHv12 00/23] git notes”
  1. Johan HerlandJan 27, 2010
  2. 01/23 Minor non-functional fixes to notes.cJohan Herland, Jan 27, 2010
  3. Junio C HamanoJan 27, 2010
  4. Johan HerlandJan 27, 2010
  5. 02/23 Notes API: get_commit_notes() -> format_note() + remove the commit restrictionJohan Herland, Jan 27, 2010
  6. 03/23 Add tests for checking correct handling of $GIT_NOTES_REF and core.notesRefJohan Herland, Jan 27, 2010
  7. 04/23 Notes API: init_notes(): Initialize the notes tree from the given notes refJohan Herland, Jan 27, 2010
  8. 05/23 Notes API: add_note(): Add note objects to the internal notes tree structureJohan Herland, Jan 27, 2010
  9. 06/23 Notes API: remove_note(): Remove note objects from the notes tree structureJohan Herland, Jan 27, 2010
  10. 07/23 Notes API: get_note(): Return the note annotating the given objectJohan Herland, Jan 27, 2010
  11. 08/23 Notes API: for_each_note(): Traverse the entire notes tree with a callbackJohan Herland, Jan 27, 2010
  12. 09/23 Notes API: write_notes_tree(): Store the notes tree in the databaseJohan Herland, Jan 27, 2010
  13. 10/23 Notes API: Allow multiple concurrent notes trees with new struct notes_treeJohan Herland, Jan 27, 2010
  14. 11/23 Refactor notes concatenation into a flexible interface for combining notesJohan Herland, Jan 27, 2010
  15. 12/23 Builtin-ify git-notesJohan Herland, Jan 27, 2010
  16. 13/23 t3301: Verify successful annotation of non-commitsJohan Herland, Jan 27, 2010
  17. 14/23 t3305: Verify that adding many notes with git-notes triggers increased fanoutJohan Herland, Jan 27, 2010
  18. 15/23 Teach notes code to properly preserve non-notes in the notes treeJohan Herland, Jan 27, 2010
  19. 16/23 Teach builtin-notes to remove empty notesJohan Herland, Jan 27, 2010
  20. 17/23 builtin-notes: Add "remove" subcommand for removing existing notesJohan Herland, Jan 27, 2010
  21. 18/23 t3305: Verify that removing notes triggers automatic fanout consolidationJohan Herland, Jan 27, 2010
  22. 19/23 Notes API: prune_notes(): Prune notes that belong to non-existing objectsJohan Herland, Jan 27, 2010
  23. 20/23 builtin-notes: Add "prune" subcommand for removing notes for missing objectsJohan Herland, Jan 27, 2010
  24. 21/23 Documentation: Generalize git-notes docs to 'objects' instead of 'commits'Johan Herland, Jan 27, 2010
  25. 22/23 builtin-notes: Add "list" subcommand for listing note objectsJohan Herland, Jan 27, 2010
  26. 23/23 builtin-notes: Add "add" subcommand for appending to note objectsJohan Herland, Jan 27, 2010
  27. Junio C HamanoJan 27, 2010
  28. Sverre RabbelierJan 27, 2010
  29. Johan HerlandJan 27, 2010
  30. Junio C HamanoJan 28, 2010
  31. Johan HerlandJan 28, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.