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

[PATCH] revision.c: introduce --notes-ref= to use one notes ref only

From
Michael J Gruber <git@drmicha.warpmail.net>
Date
Mar 29, 2011, 10:05 UTC
Message-ID
<e83f8b622fba5add563fc331ae3922b79a0af008.1301392999.git.git@drmicha.warpmail.net>

As notes become increasingly popular, it's often interesting to show notes from a particular notes ref only. Introduce '--notes-ref=<ref>' as a convenience shortcut for '--no-standard-notes --show-notes=<ref>'.

Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
---
The idea is to use the same name as in "git notes --ref=<ref>" but make
it clear for the rev-list option to be about notes, thus "--notes-ref=<ref>".
 Documentation/git-log.txt        |    3 ++-
 Documentation/pretty-options.txt |    4 ++++
 revision.c                       |   15 +++++++++++----
 t/t3301-notes.sh                 |    5 +++++
 4 files changed, 22 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 2c84028..56ffccd 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -179,7 +179,8 @@ multiple times.  A warning will be issued for refs that do not exist,
 but a glob that does not match any refs is silently ignored.
 +
 This setting can be disabled by the `--no-standard-notes` option,
-overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable,
+overridden by the 'GIT_NOTES_DISPLAY_REF' environment variable
+or the `--notes-ref` option,
 and supplemented by the `--show-notes` option.
 
 GIT
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 50923e2..ef5eed4 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -46,3 +46,7 @@ is taken to be in `refs/notes/` if it is not qualified.
 	'core.notesRef' and 'notes.displayRef' variables (or
 	corresponding environment overrides).  Enabled by default.
 	See linkgit:git-config[1].
+
+--notes-ref[=<ref>]::
+	This is the same as `--no-standard-notes --show-notes=<ref>`,
+	i.e. it shows only the notes from the notes tree at `<ref>`.
diff --git a/revision.c b/revision.c
index 0f38364..d620926 100644
--- a/revision.c
+++ b/revision.c
@@ -1368,19 +1368,26 @@ static int handle_revision_opt(struct rev_info *revs, int argc, const char **arg
 	} else if (!strcmp(arg, "--show-notes")) {
 		revs->show_notes = 1;
 		revs->show_notes_given = 1;
-	} else if (!prefixcmp(arg, "--show-notes=")) {
+	} else if (!prefixcmp(arg, "--show-notes=") || !prefixcmp(arg, "--notes-ref=")) {
 		struct strbuf buf = STRBUF_INIT;
+		int offset = strlen("--show-notes=");
 		revs->show_notes = 1;
 		revs->show_notes_given = 1;
+		if (!prefixcmp(arg, "--notes-ref=")) {
+			offset = strlen("--notes-ref=");
+			if (revs->notes_opt.extra_notes_refs)
+				string_list_clear(revs->notes_opt.extra_notes_refs, 0);
+			revs->notes_opt.suppress_default_notes = 1;
+		}
 		if (!revs->notes_opt.extra_notes_refs)
 			revs->notes_opt.extra_notes_refs = xcalloc(1, sizeof(struct string_list));
-		if (!prefixcmp(arg+13, "refs/"))
+		if (!prefixcmp(arg+offset, "refs/"))
 			/* happy */;
-		else if (!prefixcmp(arg+13, "notes/"))
+		else if (!prefixcmp(arg+offset, "notes/"))
 			strbuf_addstr(&buf, "refs/");
 		else
 			strbuf_addstr(&buf, "refs/notes/");
-		strbuf_addstr(&buf, arg+13);
+		strbuf_addstr(&buf, arg+offset);
 		string_list_append(revs->notes_opt.extra_notes_refs,
 				   strbuf_detach(&buf, NULL));
 	} else if (!strcmp(arg, "--no-notes")) {
diff --git a/t/t3301-notes.sh b/t/t3301-notes.sh
index 1921ca3..3fcfdc7 100755
--- a/t/t3301-notes.sh
+++ b/t/t3301-notes.sh
@@ -625,6 +625,11 @@ test_expect_success '--show-notes=ref accumulates' '
 	test_cmp expect-both-reversed output
 '
 
+test_expect_success '--notes-ref=' '
+	git log --notes-ref=other -1 > output &&
+	test_cmp expect-other 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 &&
-- 
1.7.4.1.607.g888da
Next: Johan Herland
Message 1 of 23 in “revision.c: introduce --notes-ref= to use one notes ref only”
  1. revision.c: introduce --notes-ref= to use one notes ref onlyMichael J Gruber, Mar 29, 2011
  2. Johan HerlandMar 29, 2011
  3. Jeff KingMar 29, 2011
  4. Michael J GruberMar 29, 2011
  5. Junio C HamanoMar 29, 2011
  6. Jeff KingMar 29, 2011
  7. 1/6 notes: make expand_notes_ref globally accessibleJeff King, Mar 29, 2011
  8. 2/6 revision.c: refactor notes ref expansionJeff King, Mar 29, 2011
  9. 3/6 notes: refactor display notes extra refs fieldJeff King, Mar 29, 2011
  10. 4/6 notes: refactor display notes default handlingJeff King, Mar 29, 2011
  11. Junio C HamanoMar 29, 2011
  12. 5/6 revision.c: support --notes command-line optionJeff King, Mar 29, 2011
  13. 6/6 revision.c: make --no-notes reset --notes listJeff King, Mar 29, 2011
  14. Junio C HamanoMar 29, 2011
  15. Johan HerlandMar 29, 2011
  16. 7/6 log/pretty-options: Document --[no-]notes and deprecate old notes optionsJohan Herland, Mar 29, 2011
  17. Jeff KingMar 30, 2011
  18. 7/6 log/pretty-options: Document --[no-]notes and deprecate old notes optionsJohan Herland, Mar 30, 2011
  19. Jeff KingMar 30, 2011
  20. Jeff KingMar 29, 2011
  21. Jeff KingMar 29, 2011
  22. Michael J GruberMar 29, 2011
  23. Jeff KingMar 29, 2011

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.