Introduce commit notes
[gitweb.git] / Documentation / config.txt
index 21ea16590b7fe017afbd2fe95c6586e784840bf8..b35a32abe115960a93c6aca0dbef9e9e56dcc585 100644 (file)
@@ -422,6 +422,21 @@ relatively high IO latencies.  With this set to 'true', git will do the
 index comparison to the filesystem data in parallel, allowing
 overlapping IO's.
 
+core.notesRef::
+       When showing commit messages, also show notes which are stored in
+       the given ref.  This ref is expected to contain paths of the form
+       ??/*, where the directory name consists of the first two
+       characters of the commit name, and the base name consists of
+       the remaining 38 characters.
++
+If such a path 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 print.
++
+This setting defaults to "refs/notes/commits", and can be overridden by
+the `GIT_NOTES_REF` environment variable.
+
 alias.*::
        Command aliases for the linkgit:git[1] command wrapper - e.g.
        after defining "alias.last = cat-file commit HEAD", the invocation