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

[PATCHv13 22/30] builtin-notes: Add "list" subcommand for listing note objects

From
Johan Herland <johan@herland.net>
Date
Feb 13, 2010, 21:28 UTC
Message-ID
<1266096518-2104-23-git-send-email-johan@herland.net>
In-Reply-To
<1266096518-2104-1-git-send-email-johan@herland.net>

"git notes list" will list all note objects in the current notes ref (in the format "<note object> <annotated object>"). "git notes list <object>" will list the note object associated with the given <object>, or fail loudly if the given <object> has no associated notes.

If no arguments are given to "git notes", it defaults to the "list" subcommand. This is for pseudo-compatibility with "git tag" and "git branch".

The patch includes tests verifying correct behaviour of the new subcommand.
Suggested-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Johan Herland <johan@herland.net>
---
 Documentation/git-notes.txt |   13 ++++++++++++-
 builtin-notes.c             |   37 ++++++++++++++++++++++++++++++++-----
 t/t3301-notes.sh            |   32 ++++++++++++++++++++++++++++++++
 3 files changed, 76 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 84db2a4..4d29d5f 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -8,7 +8,12 @@ git-notes - Add/inspect object notes
 SYNOPSIS
 --------
 [verse]
-'git notes' (edit [-F <file> | -m <msg>] | show | remove | prune) [object]
+'git notes' [list [<object>]]
+'git notes' edit [-F <file> | -m <msg>] [<object>]
+'git notes' show [<object>]
+'git notes' remove [<object>]
+'git notes' prune
+
 
 DESCRIPTION
 -----------
@@ -30,6 +35,12 @@ by the environment variable "GIT_NOTES_REF".
 SUBCOMMANDS
 -----------
 
+list::
+	List the notes object for a given object. If no object is
+	given, show a list of all note objects and the objects they
+	annotate (in the format "<note object> <annotated object>").
+	This is the default subcommand if no subcommand is given.
+
 edit::
 	Edit the notes for a given object (defaults to HEAD).
 
diff --git a/builtin-notes.c b/builtin-notes.c
index 48bc455..b808534 100644
--- a/builtin-notes.c
+++ b/builtin-notes.c
@@ -18,6 +18,7 @@
 #include "parse-options.h"
 
 static const char * const git_notes_usage[] = {
+	"git notes [list [<object>]]",
 	"git notes edit [-m <msg> | -F <file>] [<object>]",
 	"git notes show [<object>]",
 	"git notes remove [<object>]",
@@ -31,6 +32,14 @@ static const char note_template[] =
 	"# Write/edit the notes for the following object:\n"
 	"#\n";
 
+static int list_each_note(const unsigned char *object_sha1,
+		const unsigned char *note_sha1, char *note_path,
+		void *cb_data)
+{
+	printf("%s %s\n", sha1_to_hex(note_sha1), sha1_to_hex(object_sha1));
+	return 0;
+}
+
 static void write_note_data(int fd, const unsigned char *sha1)
 {
 	unsigned long size;
@@ -202,7 +211,8 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 	const char *object_ref;
 	char logmsg[100];
 
-	int edit = 0, show = 0, remove = 0, prune = 0;
+	int list = 0, edit = 0, show = 0, remove = 0, prune = 0;
+	int given_object;
 	const char *msgfile = NULL;
 	struct msg_arg msg = { 0, STRBUF_INIT };
 	struct option options[] = {
@@ -217,7 +227,9 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 
 	argc = parse_options(argc, argv, prefix, options, git_notes_usage, 0);
 
-	if (argc && !strcmp(argv[0], "edit"))
+	if (argc && !strcmp(argv[0], "list"))
+		list = 1;
+	else if (argc && !strcmp(argv[0], "edit"))
 		edit = 1;
 	else if (argc && !strcmp(argv[0], "show"))
 		show = 1;
@@ -225,8 +237,10 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 		remove = 1;
 	else if (argc && !strcmp(argv[0], "prune"))
 		prune = 1;
+	else if (!argc)
+		list = 1; /* Default to 'list' if no other subcommand given */
 
-	if (edit + show + remove + prune != 1)
+	if (list + edit + show + remove + prune != 1)
 		usage_with_options(git_notes_usage, options);
 
 	if ((msg.given || msgfile) && !edit) {
@@ -239,7 +253,8 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 		usage_with_options(git_notes_usage, options);
 	}
 
-	object_ref = argc == 2 ? argv[1] : "HEAD";
+	given_object = argc == 2;
+	object_ref = given_object ? argv[1] : "HEAD";
 	if (argc > 2 || (prune && argc > 1)) {
 		error("too many parameters");
 		usage_with_options(git_notes_usage, options);
@@ -257,9 +272,21 @@ int cmd_notes(int argc, const char **argv, const char *prefix)
 
 	note = get_note(t, object);
 
+	/* list command */
+
+	if (list) {
+		if (given_object) {
+			if (note) {
+				puts(sha1_to_hex(note));
+				return 0;
+			}
+		} else
+			return for_each_note(t, 0, list_each_note, NULL);
+	}
+
 	/* show command */
 
-	if (show && !note) {
+	if ((list || show) && !note) {
 		error("No note found for object %s.", sha1_to_hex(object));
 		return 1;
 	} else if (show) {
diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
index d29daac..768a1cb 100755
--- a/t/t3301-notes.sh
+++ b/t/t3301-notes.sh
@@ -292,6 +292,38 @@ test_expect_success 'verify note removal with "git notes remove"' '
 	! git notes show HEAD^
 '
 
+cat > expect << EOF
+c18dc024e14f08d18d14eea0d747ff692d66d6a3 1584215f1d29c65e99c6c6848626553fdd07fd75
+c9c6af7f78bc47490dbf3e822cf2f3c24d4b9061 268048bfb8a1fb38e703baceb8ab235421bf80c5
+EOF
+
+test_expect_success 'list notes with "git notes list"' '
+	git notes list > output &&
+	test_cmp expect output
+'
+
+test_expect_success 'list notes with "git notes"' '
+	git notes > output &&
+	test_cmp expect output
+'
+
+cat > expect << EOF
+c18dc024e14f08d18d14eea0d747ff692d66d6a3
+EOF
+
+test_expect_success 'list specific note with "git notes list <object>"' '
+	git notes list HEAD^^ > output &&
+	test_cmp expect output
+'
+
+cat > expect << EOF
+EOF
+
+test_expect_success 'listing non-existing notes fails' '
+	test_must_fail git notes list HEAD > output &&
+	test_cmp expect output
+'
+
 test_expect_success 'create other note on a different notes ref (setup)' '
 	: > a6 &&
 	git add a6 &&

-- 
1.7.0.rc1.141.gd3fd
Previous: Johan HerlandNext: Johan Herland
Message 23 of 35 in “[PATCHv13 00/30] git notes”
  1. Johan HerlandFeb 13, 2010
  2. 01/30 Minor cosmetic fixes to notes.cJohan Herland, Feb 13, 2010
  3. 02/30 Notes API: get_commit_notes() -> format_note() + remove the commit restrictionJohan Herland, Feb 13, 2010
  4. 03/30 Add tests for checking correct handling of $GIT_NOTES_REF and core.notesRefJohan Herland, Feb 13, 2010
  5. 04/30 Notes API: init_notes(): Initialize the notes tree from the given notes refJohan Herland, Feb 13, 2010
  6. 05/30 Notes API: add_note(): Add note objects to the internal notes tree structureJohan Herland, Feb 13, 2010
  7. 06/30 Notes API: remove_note(): Remove note objects from the notes tree structureJohan Herland, Feb 13, 2010
  8. 07/30 Notes API: get_note(): Return the note annotating the given objectJohan Herland, Feb 13, 2010
  9. 08/30 Notes API: for_each_note(): Traverse the entire notes tree with a callbackJohan Herland, Feb 13, 2010
  10. 09/30 Notes API: write_notes_tree(): Store the notes tree in the databaseJohan Herland, Feb 13, 2010
  11. 10/30 Notes API: Allow multiple concurrent notes trees with new struct notes_treeJohan Herland, Feb 13, 2010
  12. 11/30 Refactor notes concatenation into a flexible interface for combining notesJohan Herland, Feb 13, 2010
  13. 12/30 Builtin-ify git-notesJohan Herland, Feb 13, 2010
  14. 13/30 t3301: Verify successful annotation of non-commitsJohan Herland, Feb 13, 2010
  15. 14/30 t3305: Verify that adding many notes with git-notes triggers increased fanoutJohan Herland, Feb 13, 2010
  16. 15/30 Teach notes code to properly preserve non-notes in the notes treeJohan Herland, Feb 13, 2010
  17. 16/30 Teach builtin-notes to remove empty notesJohan Herland, Feb 13, 2010
  18. 17/30 builtin-notes: Add "remove" subcommand for removing existing notesJohan Herland, Feb 13, 2010
  19. 18/30 t3305: Verify that removing notes triggers automatic fanout consolidationJohan Herland, Feb 13, 2010
  20. 19/30 Notes API: prune_notes(): Prune notes that belong to non-existing objectsJohan Herland, Feb 13, 2010
  21. 20/30 builtin-notes: Add "prune" subcommand for removing notes for missing objectsJohan Herland, Feb 13, 2010
  22. 21/30 Documentation: Generalize git-notes docs to 'objects' instead of 'commits'Johan Herland, Feb 13, 2010
  23. 22/30 builtin-notes: Add "list" subcommand for listing note objectsJohan Herland, Feb 13, 2010
  24. 23/30 builtin-notes: Add --message/--file aliases for -m/-F optionsJohan Herland, Feb 13, 2010
  25. 24/30 builtin-notes: Add "add" subcommand for adding notes to objectsJohan Herland, Feb 13, 2010
  26. 25/30 builtin-notes: Add "append" subcommand for appending to note objectsJohan Herland, Feb 13, 2010
  27. 26/30 builtin-notes: Deprecate the -m/-F options for "git notes edit"Johan Herland, Feb 13, 2010
  28. 27/30 builtin-notes: Refactor handling of -F option to allow combining -m and -FJohan Herland, Feb 13, 2010
  29. 28/30 builtin-notes: Add -c/-C options for reusing notesJohan Herland, Feb 13, 2010
  30. Stephen BoydFeb 15, 2010
  31. Johan HerlandFeb 16, 2010
  32. builtin-notes: Minor (mostly parse_options-related) fixesJohan Herland, Feb 25, 2010
  33. Stephen BoydFeb 25, 2010
  34. 29/30 builtin-notes: Misc. refactoring of argc and exit value handlingJohan Herland, Feb 13, 2010
  35. 30/30 builtin-notes: Add "copy" subcommand for copying notes between objectsJohan Herland, Feb 13, 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.