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>
Thomas Rast committed
Jan 12, 2009 at 15:16 UTC
bb1dff9def343a7d513eea8f4eaa5fd7d5d3fc5f
1 file changed
+4
-6
Documentation/config.txt
+4
-6
@@ -424,15 +424,13 @@ overlapping IO's.
424
425
core.notesRef::
426
When showing commit messages, also show notes which are stored in
427
- the given ref. This ref is expected to contain paths of the form
428
- ??/*, where the directory name consists of the first two
429
- characters of the commit name, and the base name consists of
430
- the remaining 38 characters.
427
+ the given ref. This ref is expected to contain files named
428
+ after the full SHA-1 of the commit they annotate.
429
+
432
-If such a path exists in the given ref, the referenced blob is read, and
430
+If such a file exists in the given ref, the referenced blob is read, and
431
appended to the commit message, separated by a "Notes:" line. If the
432
given ref itself does not exist, it is not an error, but means that no
435
-notes should be print.
433
+notes should be printed.
434
+
435
This setting defaults to "refs/notes/commits", and can be overridden by
436
the `GIT_NOTES_REF` environment variable.