summaryrefslogtreecommitdiff
path: root/notes.h
diff options
context:
space:
mode:
authorJohannes Schindelin <Johannes.Schindelin@gmx.de>2008-12-20 13:05:14 +0100
committerJunio C Hamano <gitster@pobox.com>2008-12-21 02:47:21 -0800
commit879ef2485d6ced20845ca626ecb45a9b65aa3a70 (patch)
tree0b4d6c6219281bed3bf664f273f97e0da29b9086 /notes.h
parent5832d1a9da78273652c213d8e1535c09dd7dc079 (diff)
downloadgit-879ef2485d6ced20845ca626ecb45a9b65aa3a70.tar.gz
Introduce commit notes
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. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'notes.h')
-rw-r--r--notes.h7
1 files changed, 7 insertions, 0 deletions
diff --git a/notes.h b/notes.h
new file mode 100644
index 0000000000..79d21b65f5
--- /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