diff options
| author | Junio C Hamano <gitster@pobox.com> | 2010-06-21 05:39:16 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2010-06-21 05:39:16 -0700 |
| commit | 1b9fa0e81134df5c067efc1e3413f05c9e5043f8 (patch) | |
| tree | 7a55681b9fa624afb3768e363412d49b8871fd23 /Documentation/config.txt | |
| parent | 6f79d6689193dad107b9424e9bd699d20c7d5c33 (diff) | |
| parent | 1a3eb9a0325fc1d1d168b517210b7760d31d3022 (diff) | |
| download | git-1b9fa0e81134df5c067efc1e3413f05c9e5043f8.tar.gz git-1b9fa0e81134df5c067efc1e3413f05c9e5043f8.tar.xz | |
Merge branch 'jn/notes-doc' into maint
* jn/notes-doc:
Documentation/notes: nitpicks
Documentation/notes: clean up description of rewriting configuration
Documentation/notes: simplify treatment of default display refs
Documentation/log: add a CONFIGURATION section
Documentation/notes: simplify treatment of default notes ref
Documentation/notes: add configuration section
Documentation/notes: describe content of notes blobs
Documentation/notes: document format of notes trees
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 fc4037a7d..ae174c99d 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 |