如何防止git提交两个文件名仅在大小写上有区别的文件?

11
我们在混合环境中开发——有些人使用Mac,有些人使用Linux。这有时会带来一些挑战,因为那些使用Linux的人习惯了它们的文件系统是区分大小写的,所以提交不同大小写的多个文件(例如 FileName.extfilename.ext)是没有问题的,无论是意外还是故意。
然而,当使用Mac的人去检出存储库时,大小写不敏感的文件系统意味着仅在大小写不同时具有相同名称的两个文件将互相覆盖并造成混乱。
我知道有各种git设置可以帮助在大小写不敏感的文件系统上工作的人更好地处理大小写更改(例如core.ignorecase),但这些设置并不能解决存储库中存在仅大小写不同的两个不同文件的问题。
我意识到唯一的解决方法是确保Linux用户首先不要提交仅大小写不同的两个文件。--是否有一些git设置,如果一个在区分大小写的文件系统上的用户尝试提交可能会与另一个在不区分大小写的文件系统上混淆的文件,则会弹出警告或错误?

请注意:Unix和Linux SE帖子中介绍了一种在大多数Linux系统下查找目录中这类文件的方法,但它并没有与git相连(因此它不会在文件提交之前运行,并且不仅限于已提交的文件)。 - R.M.
1个回答

7

目前还没有内置的功能(虽然毫无疑问应该有)。您可以提供一个预提交钩子,验证所有名称是否正确,如果不正确则阻止提交。

此钩子只需要在Linux上运行(尽管使其在Linux和Mac上工作很容易,但Windows默认工具箱存在问题)。您可能需要将其添加到一个侧分支,并给Linux用户提供设置说明。

您可能还想检查分支名称,例如git pre-commit或update hook for stopping commit with branch names having Case Insensitive match中所述。 (有趣的是,这个问题的答案是我自己写的;我已经忘记了它。)

首先,让我们编写一个“检查大小写冲突”的函数。这只是一个排序问题(使用大小写折叠,以便“helloworld”和“helloWorld”相邻),然后使用uniq -di打印任何重复的(大小写折叠后)字符串,但不包括非重复项:

sort -f | uniq -di

如果有输出,那么这些就是“错误的名称”。让我们将输出捕获到一个临时文件中,并检查其大小,以便我们可以将它们打印到标准输出中:
#! /bin/sh

TF=$(mktemp)
trap "rm -f $TF" 0 1 2 3 15
checkstdin() {
    sort -f | uniq -di > $TF
    test -s $TF || return 0   # if $TF is empty, we are good
    echo "non-unique (after case folding) names found!" 1>&2
    cat $TF 1>&2
    return 1
}

现在我们只需要在将要提交的文件上使用它,可能还需要在分支名称上使用。 前者是通过 git ls-files 列出的,因此:
git ls-files | checkstdin || {
    echo "ERROR - file name collision, stopping commit" 1>&2
    exit 1
}

你可以使用 git diff-index --cached -r --name-only --diff-filter=A HEAD 命令来检查仅有新增的文件,从而使现有的重名文件继续保留。如果要跨多个分支或提交检查事物,但这会变得很困难。
将上述两个片段合并为一个脚本(并进行测试),然后只需将其复制到名为.git/hooks/pre-commit的可执行文件中即可。
检查分支名称有些棘手。 这实际上应该在创建分支名称时发生,而不是在提交时发生,并且客户端无法真正做好这项工作 - 必须在具有适当全局视图的集中式服务器上完成。
以下是一种在服务器上使用预接收脚本执行此操作的方法,它使用 shell 脚本而不是 Python(如链接答案中所示)。 但我们仍然需要 checkstdin 函数,您可能希望在更新钩子而不是在预接收钩子中执行此操作,因为您不需要拒绝整个推送,只需拒绝一个分支名称即可。
NULLSHA=0000000000000000000000000000000000000000 # 40 0s

# Verify that the given branch name $1 is unique,
# even IF we fold all existing branch names' cases.
# To be used on any proposed branch creation (we won't
# look at existing branches).
check_new_branch_name() {
    (echo "$1"; git for-each-ref --format='%(refname:short)' refs/heads) |
      checkstdin || {
        echo "ERROR: new branch name $1 is not unique after case-folding" 1>&2
        exit 1  # or set overall failure status
    }
}

while read oldsha newsha refname; do
    ... any other checks ...
    case $oldsha,$refname in
    $NULLSHA,refs/heads/*) check_new_branch_name ${refname#refs/heads/};;
    esac
    ... continue with any other checks ...
done

不同意这是git需要解决的问题,因为这将涉及到每种系统特定文件名约定的逻辑。无论如何,因为回答质量很高而投了赞成票。 - Joe Atzberger
@JoeAtzberger:确实,在这里有无穷无尽的问题。但我认为我们可以通过通用的“文件名映射”解决方案(在Git本身中)和简单的碰撞检测和操作(作为Git支持的第三方贡献代码,就像邮件后接收脚本的演变方式一样),至少将其推进90%。 对于“文件名映射”,我考虑的是类似于.gitattributes.git/info/exclude之类的东西,可能存储在.git/info中,表示“用路径Y替换路径X”。第三方代码会构建映射,而checkout会使用它。 - torek
稍微详细地说,地图实际上会应用于从索引中转换出和转换到文件的过程中,就像清理和涂抹过滤器以及行尾(CR / LF)转换过滤器一样。这将允许Windows或Mac用户提取,修改和提交其无法实际访问名称的文件。除非证明是实际可行的(似乎不太可能),否则不打算长期普遍使用。 - torek

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接