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

[PATCHv12 04/23] Notes API: init_notes(): Initialize the notes tree from the given notes ref

From
Johan Herland <johan@herland.net>
Date
Jan 27, 2010, 11:51 UTC
Message-ID
<1264593120-4428-5-git-send-email-johan@herland.net>
In-Reply-To
<1264593120-4428-1-git-send-email-johan@herland.net>
Created by a simple refactoring of initialize_notes().

Also add a new 'flags' parameter, which is a bitwise combination of notes initialization flags. For now, there is only one flag - NOTES_INIT_EMPTY - which indicates that the notes tree should not auto-load the contents of the given (or default) notes ref, but rather should leave the notes tree initialized to an empty state. This will become useful in the future when manipulating the notes tree through the notes API.

Signed-off-by: Johan Herland <johan@herland.net>
---
 notes.c |   30 ++++++++++++++++++------------
 notes.h |   20 ++++++++++++++++++++
 2 files changed, 38 insertions(+), 12 deletions(-)
diff --git a/notes.c b/notes.c
index 4ee4fec..3f4ae35 100644
--- a/notes.c
+++ b/notes.c
@@ -340,15 +340,28 @@ static void load_subtree(struct leaf_node *subtree, struct int_node *node,
 	free(buf);
 }
 
-static void initialize_notes(const char *notes_ref_name)
+void init_notes(const char *notes_ref, int flags)
 {
 	unsigned char sha1[20], object_sha1[20];
 	unsigned mode;
 	struct leaf_node root_tree;
 
-	if (!notes_ref_name || read_ref(notes_ref_name, object_sha1) ||
-	    get_tree_entry(object_sha1, "", sha1, &mode))
+	assert(!initialized);
+	initialized = 1;
+
+	if (!notes_ref)
+		notes_ref = getenv(GIT_NOTES_REF_ENVIRONMENT);
+	if (!notes_ref)
+		notes_ref = notes_ref_name; /* value of core.notesRef config */
+	if (!notes_ref)
+		notes_ref = GIT_NOTES_DEFAULT_REF;
+
+	if (flags & NOTES_INIT_EMPTY || !notes_ref ||
+	    read_ref(notes_ref, object_sha1))
 		return;
+	if (get_tree_entry(object_sha1, "", sha1, &mode))
+		die("Failed to read notes tree referenced by %s (%s)",
+		    notes_ref, object_sha1);
 
 	hashclr(root_tree.key_sha1);
 	hashcpy(root_tree.val_sha1, sha1);
@@ -379,15 +392,8 @@ void format_note(const unsigned char *object_sha1, struct strbuf *sb,
 	unsigned long linelen, msglen;
 	enum object_type type;
 
-	if (!initialized) {
-		const char *env = getenv(GIT_NOTES_REF_ENVIRONMENT);
-		if (env)
-			notes_ref_name = getenv(GIT_NOTES_REF_ENVIRONMENT);
-		else if (!notes_ref_name)
-			notes_ref_name = GIT_NOTES_DEFAULT_REF;
-		initialize_notes(notes_ref_name);
-		initialized = 1;
-	}
+	if (!initialized)
+		init_notes(NULL, 0);
 
 	sha1 = lookup_notes(object_sha1);
 	if (!sha1)
diff --git a/notes.h b/notes.h
index d745ed1..6b52799 100644
--- a/notes.h
+++ b/notes.h
@@ -1,6 +1,26 @@
 #ifndef NOTES_H
 #define NOTES_H
 
+/*
+ * Flags controlling behaviour of notes tree initialization
+ *
+ * Default behaviour is to initialize the notes tree from the tree object
+ * specified by the given (or default) notes ref.
+ */
+#define NOTES_INIT_EMPTY 1
+
+/*
+ * Initialize internal notes tree structure with the notes tree at the given
+ * ref. If given ref is NULL, the value of the $GIT_NOTES_REF environment
+ * variable is used, and if that is missing, the default notes ref is used
+ * ("refs/notes/commits").
+ *
+ * If you need to re-intialize the internal notes tree structure (e.g. loading
+ * from a different notes ref), please first de-initialize the current notes
+ * tree by calling free_notes().
+ */
+void init_notes(const char *notes_ref, int flags);
+
 /* Free (and de-initialize) the internal notes tree structure */
 void free_notes(void);
 
-- 
1.6.6.405.g80ed6
Previous: Johan HerlandNext: Johan Herland
Message 7 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.