diff options
| author | Jonathan Nieder <jrnieder@gmail.com> | 2010-05-08 22:19:35 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2010-05-08 22:30:02 -0700 |
| commit | 9eb3f816dea9fa00e7c20204516b0cb288219057 (patch) | |
| tree | 86d5cd1f721816278f74aff5648527d449f30118 /Documentation/config.txt | |
| parent | d599e0484f8ebac8cc50e9557a4c3d246826843d (diff) | |
| download | git-9eb3f816dea9fa00e7c20204516b0cb288219057.tar.gz git-9eb3f816dea9fa00e7c20204516b0cb288219057.tar.xz | |
Documentation/notes: document format of notes trees
Separate the specification of the notes format exposed in
git-config.1 from the description of the option; or in other
words, move the explanation for what to expect to find at
refs/notes/commits from git-config.1 to git-notes.1.
Suggested-by: Thomas Rast <trast@student.ethz.ch>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config.txt')
| -rw-r--r-- | Documentation/config.txt | 16 |
1 files changed, 5 insertions, 11 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt index 92f851e79..295928ea7 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -518,18 +518,12 @@ check that makes sure that existing object files will not get overwritten. core.notesRef:: When showing commit messages, also show notes which are stored in - the given ref. This ref is expected to contain files named - after the full SHA-1 of the commit they annotate. The ref - must be fully qualified. + the given ref. The ref must be fully qualified. If the given + ref does not exist, it is not an error but means that no + notes should be printed. + -If such a file exists in the given ref, the referenced blob is read, and -appended to the commit message, separated by a "Notes (<refname>):" -line (shortened to "Notes:" in the case of "refs/notes/commits"). If the -given ref itself does not exist, it is not an error, but means that no -notes should be printed. -+ -This setting defaults to "refs/notes/commits", and can be overridden by -the `GIT_NOTES_REF` environment variable. +This setting defaults to "refs/notes/commits", and it can be overridden by +the 'GIT_NOTES_REF' environment variable. See linkgit:git-notes[1]. core.sparseCheckout:: Enable "sparse checkout" feature. See section "Sparse checkout" in |