diff options
| author | Jeff King <peff@peff.net> | 2021-05-03 20:43:28 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-05-04 02:52:03 (GMT) |
| commit | 8ff06de10c12ef1f796fcefb96166133965d510e (patch) | |
| tree | 9c06e239e9b378f112729305c5240e64532a617b /Documentation/gitmailmap.txt | |
| parent | bb6832d5529a75164acca7c0412657c96a9a5764 (diff) | |
| download | git-8ff06de10c12ef1f796fcefb96166133965d510e.zip git-8ff06de10c12ef1f796fcefb96166133965d510e.tar.gz git-8ff06de10c12ef1f796fcefb96166133965d510e.tar.bz2 | |
docs: document symlink restrictions for dot-files
We stopped allowing symlinks for .gitmodules files in 10ecfa7649
(verify_path: disallow symlinks in .gitmodules, 2018-05-04), and we
stopped following symlinks for .gitattributes, .gitignore, and .mailmap
in the commits from 204333b015 (Merge branch 'jk/open-dotgitx-with-nofollow',
2021-03-22). The reasons are discussed in detail there, but we never
adjusted the documentation to let users know.
This hasn't been a big deal since the point is that such setups were
mildly broken and thought to be unusual anyway. But it certainly doesn't
hurt to be clear and explicit about it.
Suggested-by: Philip Oakley <philipoakley@iee.email>
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/gitmailmap.txt')
| -rw-r--r-- | Documentation/gitmailmap.txt | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/gitmailmap.txt b/Documentation/gitmailmap.txt index 3fb39f8..06f4af9 100644 --- a/Documentation/gitmailmap.txt +++ b/Documentation/gitmailmap.txt @@ -55,6 +55,13 @@ this would also match the 'Commit Name <commit@email.xx>' above: Proper Name <proper@email.xx> CoMmIt NaMe <CoMmIt@EmAiL.xX> -- +NOTES +----- + +Git does not follow symbolic links when accessing a `.mailmap` file in +the working tree. This keeps behavior consistent when the file is +accessed from the index or a tree versus from the filesystem. + EXAMPLES -------- |