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

[PATCHv11 17/20] builtin-notes: Teach -d option for deleting existing notes

From
Johan Herland <johan@herland.net>
Date
Jan 17, 2010, 21:04 UTC
Message-ID
<1263762277-31419-18-git-send-email-johan@herland.net>
In-Reply-To
<1263762277-31419-1-git-send-email-johan@herland.net>

Using -d is equivalent to specifying an empty note message. This option is provided largely for consistency with other git commands, such as git tag and git branch.

The patch includes tests verifying the correct behaviour of the new option.
Signed-off-by: Johan Herland <johan@herland.net>
---
 Documentation/git-notes.txt |   13 ++++++++-----
 builtin-notes.c             |   16 ++++++++++------
 t/t3301-notes.sh            |   27 +++++++++++++++++++++++++++
 3 files changed, 45 insertions(+), 11 deletions(-)
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index bb73b02..bac34bb 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> | -d] | show) [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
@@ -44,6 +44,9 @@ OPTIONS
 	Take the note message from the given file.  Use '-' to
 	read the note message from the standard input.
 
+-d::
+	Remove the note. This is equivalent to specifying an
+	empty note message.
 
 Author
 ------
diff --git a/builtin-notes.c b/builtin-notes.c
index 0cce608..a166ad0 100644
--- a/builtin-notes.c
+++ b/builtin-notes.c
@@ -17,7 +17,7 @@
 #include "parse-options.h"
 
 static const char * const git_notes_usage[] = {
-	"git notes edit [-m <msg>|-F <file>] [<object>]",
+	"git notes edit [-m <msg> | -F <file> | -d] [<object>]",
 	"git notes show [<object>]",
 	NULL
 };
@@ -159,7 +159,7 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 	const unsigned char *note;
 	const char *object_ref, *logmsg;
 
-	int edit = 0, show = 0;
+	int edit = 0, show = 0, delete = 0;
 	const char *msgfile = NULL;
 	struct msg_arg msg = { 0, STRBUF_INIT };
 	struct option options[] = {
@@ -167,6 +167,7 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 		OPT_CALLBACK('m', NULL, &msg, "msg",
 			     "note contents as a string", parse_msg_arg),
 		OPT_FILENAME('F', NULL, &msgfile, "note contents in a file"),
+		OPT_BOOLEAN('d', NULL, &delete, "delete existing note"),
 		OPT_END()
 	};
 
@@ -212,13 +213,15 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 
 	/* edit command */
 
-	if (msg.given || msgfile) {
-		if (msg.given && msgfile) {
-			error("mixing -m and -F options is not allowed.");
+	if (msg.given || msgfile || delete) {
+		if (msg.given + delete + (msgfile ? 1 : 0) > 1) {
+			error("mixing -m/-F/-d options is not allowed.");
 			usage_with_options(git_notes_usage, options);
 		}
 		if (msg.given)
 			strbuf_addbuf(&buf, &(msg.buf));
+		else if (delete)
+			strbuf_reset(&buf);
 		else {
 			if (!strcmp(msgfile, "-")) {
 				if (strbuf_read(&buf, 0, 1024) < 0)
@@ -231,7 +234,8 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 		}
 	}
 
-	create_note(object, &buf, msg.given || msgfile, note, new_note);
+	create_note(object, &buf, msg.given || msgfile || delete, note,
+		    new_note);
 	if (is_null_sha1(new_note)) {
 		remove_note(t, object);
 		logmsg = "Note removed by 'git notes edit'";
diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
index 404a94b..8617c2f 100755
--- a/t/t3301-notes.sh
+++ b/t/t3301-notes.sh
@@ -212,6 +212,33 @@ test_expect_success 'verify non-creation of note with -m ""' '
 	! git notes show
 '
 
+test_expect_success 'remove note with -d (setup)' '
+	git notes edit -d HEAD^
+'
+
+cat > expect-rm-d << EOF
+commit bd1753200303d0a0344be813e504253b3d98e74d
+Author: A U Thor <author@example.com>
+Date:   Thu Apr 7 15:17:13 2005 -0700
+
+    5th
+
+commit 15023535574ded8b1a89052b32673f84cf9582b8
+Author: A U Thor <author@example.com>
+Date:   Thu Apr 7 15:16:13 2005 -0700
+
+    4th
+EOF
+
+printf "\n" >> expect-rm-d
+cat expect-multiline >> expect-rm-d
+
+test_expect_success 'verify note removal with -d' '
+	git log -4 > output &&
+	test_cmp expect-rm-d output &&
+	! git notes show HEAD^
+'
+
 test_expect_success 'create other note on a different notes ref (setup)' '
 	: > a6 &&
 	git add a6 &&

-- 
1.6.6.rc1.321.g0496e
Previous: Johan HerlandNext: Johan Herland
Message 20 of 26 in “[PATCHv11 00/20] git notes”
  1. Johan HerlandJan 17, 2010
  2. 01/20 Minor non-functional fixes to notes.cJohan Herland, Jan 17, 2010
  3. 02/20 Notes API: get_commit_notes() -> format_note() + remove the commit restrictionJohan Herland, Jan 17, 2010
  4. 03/20 Add tests for checking correct handling of $GIT_NOTES_REF and core.notesRefJohan Herland, Jan 17, 2010
  5. 04/20 Notes API: init_notes(): Initialize the notes tree from the given notes refJohan Herland, Jan 17, 2010
  6. 05/20 Notes API: add_note(): Add note objects to the internal notes tree structureJohan Herland, Jan 17, 2010
  7. 06/20 Notes API: remove_note(): Remove note objects from the notes tree structureJohan Herland, Jan 17, 2010
  8. 07/20 Notes API: get_note(): Return the note annotating the given objectJohan Herland, Jan 17, 2010
  9. 08/20 Notes API: for_each_note(): Traverse the entire notes tree with a callbackJohan Herland, Jan 17, 2010
  10. 09/20 Notes API: write_notes_tree(): Store the notes tree in the databaseJohan Herland, Jan 17, 2010
  11. 10/20 Notes API: Allow multiple concurrent notes trees with new struct notes_treeJohan Herland, Jan 17, 2010
  12. 11/20 Refactor notes concatenation into a flexible interface for combining notesJohan Herland, Jan 17, 2010
  13. 12/20 Builtin-ify git-notesJohan Herland, Jan 17, 2010
  14. Stephen BoydJan 21, 2010
  15. Johan HerlandJan 26, 2010
  16. 13/20 t3301: Verify successful annotation of non-commitsJohan Herland, Jan 17, 2010
  17. 14/20 t3305: Verify that adding many notes with git-notes triggers increased fanoutJohan Herland, Jan 17, 2010
  18. 15/20 Teach notes code to properly preserve non-notes in the notes treeJohan Herland, Jan 17, 2010
  19. 16/20 Teach builtin-notes to remove empty notesJohan Herland, Jan 17, 2010
  20. 17/20 builtin-notes: Teach -d option for deleting existing notesJohan Herland, Jan 17, 2010
  21. 18/20 t3305: Verify that removing notes triggers automatic fanout consolidationJohan Herland, Jan 17, 2010
  22. 19/20 Notes API: gc_notes(): Prune notes that belong to non-existing objectsJohan Herland, Jan 17, 2010
  23. 20/20 builtin-gc: Teach the new --notes option to garbage-collect notesJohan Herland, Jan 17, 2010
  24. Stephen BoydJan 21, 2010
  25. Junio C HamanoJan 21, 2010
  26. Johan HerlandJan 27, 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.