development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-08-27 03:29:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

notes: fix core.notesRef documentation

Browse source 
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>
This commit is contained in:
Thomas Rast 2009-01-12 15:16:04 +01:00 committed by Junio C Hamano
parent 009318b1f1
commit bb1dff9def
1 changed files with 4 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Documentation/config.txt
View file

@ -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.