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

[PATCHv5 01/14] Introduce commit notes

From
Johan Herland <johan@herland.net>
Date
Sep 8, 2009, 02:26 UTC
Message-ID
<1252376822-6138-2-git-send-email-johan@herland.net>
In-Reply-To
<1252376822-6138-1-git-send-email-johan@herland.net>
From: Johannes Schindelin <Johannes.Schindelin@gmx.de>

Commit notes are blobs which are shown together with the commit message. These blobs are taken from the notes ref, which you can configure by the config variable core.notesRef, which in turn can be overridden by the environment variable GIT_NOTES_REF.

The notes ref is a branch which contains "files" whose names are the names of the corresponding commits (i.e. the SHA-1).

The rationale for putting this information into a ref is this: we want to be able to fetch and possibly union-merge the notes, maybe even look at the date when a note was introduced, and we want to store them efficiently together with the other objects.

This patch has been improved by the following contributions:
- Thomas Rast: fix core.notesRef documentation
- Tor Arne Vestbø: fix printing of multi-line notes
- Alex Riesen: Using char array instead of char pointer costs less BSS
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Thomas Rast <trast@student.ethz.ch>
Signed-off-by: Tor Arne Vestbø <tavestbo@trolltech.com>
Signed-off-by: Johan Herland <johan@herland.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/config.txt |   13 +++++++++
 Makefile                 |    2 +
 cache.h                  |    4 +++
 commit.c                 |    1 +
 config.c                 |    5 +++
 environment.c            |    1 +
 notes.c                  |   68 ++++++++++++++++++++++++++++++++++++++++++++++
 notes.h                  |    7 +++++
 pretty.c                 |    5 +++
 9 files changed, 106 insertions(+), 0 deletions(-)
 create mode 100644 notes.c
 create mode 100644 notes.h
diff --git a/Documentation/config.txt b/Documentation/config.txt
index d445395..728d787 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -443,6 +443,19 @@ On some file system/operating system combinations, this is unreliable.
 Set this config setting to 'rename' there; However, This will remove the
 check that makes sure that existing object files will not get overwritten.
 
+core.notesRef::
+	When showing commit messages, also show notes which are stored in
+	the given ref.  This ref is expected to contain files named
+	after the full SHA-1 of the commit they annotate.
++
+If such a file exists in the given ref, the referenced blob is read, and
+appended to the commit message, separated by a "Notes:" line.  If the
+given ref itself does not exist, it is not an error, but means that no
+notes should be printed.
++
+This setting defaults to "refs/notes/commits", and can be overridden by
+the `GIT_NOTES_REF` environment variable.
+
 add.ignore-errors::
 	Tells 'git-add' to continue adding files when some files cannot be
 	added due to indexing errors. Equivalent to the '--ignore-errors'
diff --git a/Makefile b/Makefile
index ce882d0..37b8f85 100644
--- a/Makefile
+++ b/Makefile
@@ -426,6 +426,7 @@ LIB_H += ll-merge.h
 LIB_H += log-tree.h
 LIB_H += mailmap.h
 LIB_H += merge-recursive.h
+LIB_H += notes.h
 LIB_H += object.h
 LIB_H += pack.h
 LIB_H += pack-refs.h
@@ -509,6 +510,7 @@ LIB_OBJS += match-trees.o
 LIB_OBJS += merge-file.o
 LIB_OBJS += merge-recursive.o
 LIB_OBJS += name-hash.o
+LIB_OBJS += notes.o
 LIB_OBJS += object.o
 LIB_OBJS += pack-check.o
 LIB_OBJS += pack-refs.o
diff --git a/cache.h b/cache.h
index ae324c9..917138b 100644
--- a/cache.h
+++ b/cache.h
@@ -371,6 +371,8 @@ static inline enum object_type object_type(unsigned int mode)
 #define GITATTRIBUTES_FILE ".gitattributes"
 #define INFOATTRIBUTES_FILE "info/attributes"
 #define ATTRIBUTE_MACRO_PREFIX "[attr]"
+#define GIT_NOTES_REF_ENVIRONMENT "GIT_NOTES_REF"
+#define GIT_NOTES_DEFAULT_REF "refs/notes/commits"
 
 extern int is_bare_repository_cfg;
 extern int is_bare_repository(void);
@@ -565,6 +567,8 @@ enum object_creation_mode {
 
 extern enum object_creation_mode object_creation_mode;
 
+extern char *notes_ref_name;
+
 extern int grafts_replace_parents;
 
 #define GIT_REPO_VERSION 0
diff --git a/commit.c b/commit.c
index a6c6f70..a0a77a6 100644
--- a/commit.c
+++ b/commit.c
@@ -5,6 +5,7 @@
 #include "utf8.h"
 #include "diff.h"
 #include "revision.h"
+#include "notes.h"
 
 int save_commit_buffer = 1;
 
diff --git a/config.c b/config.c
index e87edea..70a7d34 100644
--- a/config.c
+++ b/config.c
@@ -467,6 +467,11 @@ static int git_default_core_config(const char *var, const char *value)
 		return 0;
 	}
 
+	if (!strcmp(var, "core.notesref")) {
+		notes_ref_name = xstrdup(value);
+		return 0;
+	}
+
 	if (!strcmp(var, "core.pager"))
 		return git_config_string(&pager_program, var, value);
 
diff --git a/environment.c b/environment.c
index 5de6837..571ab56 100644
--- a/environment.c
+++ b/environment.c
@@ -49,6 +49,7 @@ enum push_default_type push_default = PUSH_DEFAULT_MATCHING;
 #define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS
 #endif
 enum object_creation_mode object_creation_mode = OBJECT_CREATION_MODE;
+char *notes_ref_name;
 int grafts_replace_parents = 1;
 
 /* Parallel index stat data preload? */
diff --git a/notes.c b/notes.c
new file mode 100644
index 0000000..401966d
--- /dev/null
+++ b/notes.c
@@ -0,0 +1,68 @@
+#include "cache.h"
+#include "commit.h"
+#include "notes.h"
+#include "refs.h"
+#include "utf8.h"
+#include "strbuf.h"
+
+static int initialized;
+
+void get_commit_notes(const struct commit *commit, struct strbuf *sb,
+		const char *output_encoding)
+{
+	static const char utf8[] = "utf-8";
+	struct strbuf name = STRBUF_INIT;
+	unsigned char sha1[20];
+	char *msg, *msg_p;
+	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;
+		if (notes_ref_name && read_ref(notes_ref_name, sha1))
+			notes_ref_name = NULL;
+		initialized = 1;
+	}
+
+	if (!notes_ref_name)
+		return;
+
+	strbuf_addf(&name, "%s:%s", notes_ref_name,
+			sha1_to_hex(commit->object.sha1));
+	if (get_sha1(name.buf, sha1))
+		return;
+
+	if (!(msg = read_sha1_file(sha1, &type, &msglen)) || !msglen ||
+			type != OBJ_BLOB)
+		return;
+
+	if (output_encoding && *output_encoding &&
+			strcmp(utf8, output_encoding)) {
+		char *reencoded = reencode_string(msg, output_encoding, utf8);
+		if (reencoded) {
+			free(msg);
+			msg = reencoded;
+			msglen = strlen(msg);
+		}
+	}
+
+	/* we will end the annotation by a newline anyway */
+	if (msglen && msg[msglen - 1] == '\n')
+		msglen--;
+
+	strbuf_addstr(sb, "\nNotes:\n");
+
+	for (msg_p = msg; msg_p < msg + msglen; msg_p += linelen + 1) {
+		linelen = strchrnul(msg_p, '\n') - msg_p;
+
+		strbuf_addstr(sb, "    ");
+		strbuf_add(sb, msg_p, linelen);
+		strbuf_addch(sb, '\n');
+	}
+
+	free(msg);
+}
diff --git a/notes.h b/notes.h
new file mode 100644
index 0000000..79d21b6
--- /dev/null
+++ b/notes.h
@@ -0,0 +1,7 @@
+#ifndef NOTES_H
+#define NOTES_H
+
+void get_commit_notes(const struct commit *commit, struct strbuf *sb,
+		const char *output_encoding);
+
+#endif
diff --git a/pretty.c b/pretty.c
index f5983f8..e25db81 100644
--- a/pretty.c
+++ b/pretty.c
@@ -6,6 +6,7 @@
 #include "string-list.h"
 #include "mailmap.h"
 #include "log-tree.h"
+#include "notes.h"
 #include "color.h"
 
 static char *user_format;
@@ -975,5 +976,9 @@ void pretty_print_commit(enum cmit_fmt fmt, const struct commit *commit,
 	 */
 	if (fmt == CMIT_FMT_EMAIL && sb->len <= beginning_of_body)
 		strbuf_addch(sb, '\n');
+
+	if (fmt != CMIT_FMT_ONELINE)
+		get_commit_notes(commit, sb, encoding);
+
 	free(reencoded);
 }

-- 
1.6.4.304.g1365c.dirty
Previous: Johan HerlandNext: Johan Herland
Message 2 of 58 in “[PATCHv5 00/14] git notes”
  1. Johan HerlandSep 8, 2009
  2. 01/14 Introduce commit notesJohan Herland, Sep 8, 2009
  3. 02/14 Add a script to edit/inspect notesJohan Herland, Sep 8, 2009
  4. 03/14 Speed up git notes lookupJohan Herland, Sep 8, 2009
  5. 04/14 Add an expensive test for git-notesJohan Herland, Sep 8, 2009
  6. 05/14 Teach "-m <msg>" and "-F <file>" to "git notes edit"Johan Herland, Sep 8, 2009
  7. 06/14 fast-import: Add support for importing commit notesJohan Herland, Sep 8, 2009
  8. 07/14 t3302-notes-index-expensive: Speed up create_repo()Johan Herland, Sep 8, 2009
  9. 08/14 Add flags to get_commit_notes() to control the format of the note stringJohan Herland, Sep 8, 2009
  10. 09/14 Add '%N'-format for pretty-printing commit notesJohan Herland, Sep 8, 2009
  11. 10/14 Teach notes code to free its internal data structures on request.Johan Herland, Sep 8, 2009
  12. 11/14 Teach the notes lookup code to parse notes trees with various fanout schemesJohan Herland, Sep 8, 2009
  13. 12/14 Selftests verifying semantics when loading notes trees with various fanoutsJohan Herland, Sep 8, 2009
  14. 13/14 Allow flexible organization of notes trees, using both commit date and SHA1Johan Herland, Sep 8, 2009
  15. 14/14 Add test cases for date-based fanoutsJohan Herland, Sep 8, 2009
  16. Johan HerlandSep 8, 2009
  17. Junio C HamanoSep 8, 2009
  18. Johan HerlandSep 8, 2009
  19. Johannes SchindelinSep 8, 2009
  20. Johan HerlandSep 8, 2009
  21. Johannes SchindelinSep 8, 2009
  22. Johan HerlandSep 8, 2009
  23. Stephen R. van den BergSep 10, 2009
  24. Johan HerlandSep 10, 2009
  25. Junio C HamanoSep 8, 2009
  26. Shawn O. PearceSep 8, 2009
  27. Sverre RabbelierSep 8, 2009
  28. Shawn O. PearceSep 8, 2009
  29. Sverre RabbelierSep 8, 2009
  30. Johan HerlandSep 8, 2009
  31. Johan HerlandSep 12, 2009
  32. Shawn O. PearceSep 12, 2009
  33. Johan HerlandSep 12, 2009
  34. Geert BoschSep 10, 2009
  35. Michael J GruberSep 10, 2009
  36. Geert BoschSep 10, 2009
  37. Junio C HamanoSep 12, 2009
  38. Johan HerlandSep 12, 2009
  39. 00/14 git notesJohan Herland, Sep 12, 2009
  40. 01/14 Introduce commit notesJohan Herland, Sep 12, 2009
  41. 02/14 Add a script to edit/inspect notesJohan Herland, Sep 12, 2009
  42. 03/14 Speed up git notes lookupJohan Herland, Sep 12, 2009
  43. 04/14 Add an expensive test for git-notesJohan Herland, Sep 12, 2009
  44. 05/14 Teach "-m <msg>" and "-F <file>" to "git notes edit"Johan Herland, Sep 12, 2009
  45. 06/14 fast-import: Add support for importing commit notesJohan Herland, Sep 12, 2009
  46. 07/14 t3302-notes-index-expensive: Speed up create_repo()Johan Herland, Sep 12, 2009
  47. 08/14 Add flags to get_commit_notes() to control the format of the note stringJohan Herland, Sep 12, 2009
  48. 09/14 Add '%N'-format for pretty-printing commit notesJohan Herland, Sep 12, 2009
  49. 10/14 Teach notes code to free its internal data structures on request.Johan Herland, Sep 12, 2009
  50. Junio C HamanoSep 12, 2009
  51. Johan HerlandSep 12, 2009
  52. 11/14 Teach the notes lookup code to parse notes trees with various fanout schemesJohan Herland, Sep 12, 2009
  53. 12/14 Selftests verifying semantics when loading notes trees with various fanoutsJohan Herland, Sep 12, 2009
  54. 13/14 Allow flexible organization of notes trees, using both commit date and SHA1Johan Herland, Sep 12, 2009
  55. Junio C HamanoSep 12, 2009
  56. Johan HerlandSep 12, 2009
  57. Junio C HamanoSep 12, 2009
  58. 14/14 Add test cases for various date-based fanoutsJohan Herland, Sep 12, 2009

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.