diff options
| author |  Johannes Schindelin <Johannes.Schindelin@gmx.de> | 2008-12-20 13:05:14 +0100 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2008-12-21 02:47:21 -0800 |
| commit | 879ef2485d6ced20845ca626ecb45a9b65aa3a70 (patch) | |
| tree | 0b4d6c6219281bed3bf664f273f97e0da29b9086 /Documentation | |
| parent | Documentation: fix typos, grammar, asciidoc syntax (diff) | |
| download | tgif-879ef2485d6ced20845ca626ecb45a9b65aa3a70.tar.xz | |
Introduce commit notes
Commit notes are blobs which are shown together with the commit
message. These blobs are taken from the notes ref, which you can
configure by the config variable core.notesRef, which in turn can
be overridden by the environment variable GIT_NOTES_REF.
The notes ref is a branch which contains "files" whose names are
the names of the corresponding commits (i.e. the SHA-1).
The rationale for putting this information into a ref is this: we
want to be able to fetch and possibly union-merge the notes,
maybe even look at the date when a note was introduced, and we
want to store them efficiently together with the other objects.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/config.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index 21ea16590b..b35a32abe1 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -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 |