aboutsummaryrefslogtreecommitdiff
path: root/Documentation/config.txt
diff options
context:
space:
mode:
authorThomas Rast <trast@student.ethz.ch>2009-01-12 15:16:04 +0100
committerJunio C Hamano <gitster@pobox.com>2009-01-13 00:14:14 -0800
commitbb1dff9def343a7d513eea8f4eaa5fd7d5d3fc5f (patch)
tree531eec51adf581cc5d7b6c255ded360ea19d87e0 /Documentation/config.txt
parent009318b1f1db24588d93bc658ea6c6a5324c9c3c (diff)
downloadgit-bb1dff9def343a7d513eea8f4eaa5fd7d5d3fc5f.tar.gz
git-bb1dff9def343a7d513eea8f4eaa5fd7d5d3fc5f.tar.xz
notes: fix core.notesRef documentation
The path format was inconsistent with the one used in git-notes.sh: it supposedly split the sha1 in the same 2/38 format that .git/objects uses, but the code uses the full sha1 without a path separator. While at it, also fix a grammatical error. Signed-off-by: Thomas Rast <trast@student.ethz.ch> Acked-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config.txt')
-rw-r--r--Documentation/config.txt10
1 files changed, 4 insertions, 6 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index b35a32abe..2fdca0ea3 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -424,15 +424,13 @@ 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.
+ the given ref. This ref is expected to contain files named
+ after the full SHA-1 of the commit they annotate.
+
-If such a path exists in the given ref, the referenced blob is read, and
+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 print.
+notes should be printed.
+
This setting defaults to "refs/notes/commits", and can be overridden by
the `GIT_NOTES_REF` environment variable.