docs: document symlink restrictions for dot-files
authorJeff King <peff@peff.net>
Mon, 3 May 2021 20:43:28 +0000 (16:43 -0400)
committerJunio C Hamano <gitster@pobox.com>
Tue, 4 May 2021 02:52:03 +0000 (11:52 +0900)
commit8ff06de10c12ef1f796fcefb96166133965d510e
tree9c06e239e9b378f112729305c5240e64532a617b
parentbb6832d5529a75164acca7c0412657c96a9a5764
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>
Documentation/gitattributes.txt
Documentation/gitignore.txt
Documentation/gitmailmap.txt
Documentation/gitmodules.txt