notes.h: Make default_notes_ref() available in notes API

[thirdparty/git.git] / notes.h

diff --git a/notes.h b/notes.h
index c0288b0d32d5fd63ba691e4d7f272ddb4ae319da..20db42fe952ed330c831563085236cd3a082e435 100644 (file)
--- a/notes.h
+++ b/notes.h
@@ -43,6 +43,20 @@ extern struct notes_tree {
        int dirty;
 } default_notes_tree;
 
+/*
+ * Return the default notes ref.
+ *
+ * The default notes ref is the notes ref that is used when notes_ref == NULL
+ * is passed to init_notes().
+ *
+ * This the first of the following to be defined:
+ * 1. The '--ref' option to 'git notes', if given
+ * 2. The $GIT_NOTES_REF environment variable, if set
+ * 3. The value of the core.notesRef config variable, if set
+ * 4. GIT_NOTES_DEFAULT_REF (i.e. "refs/notes/commits")
+ */
+const char *default_notes_ref(void);
+
 /*
  * Flags controlling behaviour of notes tree initialization
  *