如何防止 git 提交两个名称仅大小写不同的文件?
How to prevent git from committing two files with names differing only in case?
我们在混合环境中开发 - 有些人在 Mac 上工作,有些人在 Linux 上工作。这有时被证明是一个挑战,因为那些在 Linux 上工作的人习惯于让他们的文件系统区分大小写,所以提交(意外或其他)多个文件只是大小写不同是没有问题的. (例如 FileName.ext
与 filename.ext
)
但是,当使用 Mac 的人去检查存储库时,拥有不区分大小写的文件系统意味着这两个文件(仅大小写不同)会相互覆盖并造成全面破坏。
我知道有多种 git 设置可以帮助使用不区分大小写的文件系统的人更好地处理大小写更改(例如 core.ignorecase
),但是这些设置并不能解决有两个问题的问题存储库中的不同文件,仅大小写不同。
我意识到修复它的唯一方法是确保 Linux 人们不会首先提交两个仅大小写不同的文件。 -- git 中是否有某些设置会在区分大小写的文件系统上的用户尝试提交在不区分大小写的文件系统上会相互混淆的文件时弹出警告或错误?
没有内置任何东西(尽管应该有,毫无疑问)。您可以做的是提供一个预提交挂钩,验证所有名称是否正确,如果不正确则阻止提交。
这个钩子只需要 运行 在 Linux 框上(尽管让它在 Linux 和 Mac 上工作很容易,它只是 Windows 其默认的贫乏工具箱是有问题的)。您可能想将它添加到侧分支并向 Linux 人员提供有关设置它的说明。
您可能还想检查分支 names,就像在 中一样。 (有趣:这个问题的答案是我自己的;我忘记了。)
首先,让我们编写一个"check for case conflict"函数。这只是大小写排序的问题(因此 "helloworld" 和 "helloWorld" 彼此相邻放置),然后使用 uniq -di
打印任何重复项(大小写折叠后)字符串,但没有非重复项:
sort -f | uniq -di
如果这产生任何输出,这些是 "bad names"。让我们将输出捕获到一个临时文件中并检查其大小,以便我们也可以将它们打印到标准输出:
#! /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
只检查 添加的 文件,允许现有的案例冲突继续,and/or 尝试跨检查许多分支 and/or 提交,但这变得困难。
将以上两个片段合并成一个脚本(并测试),然后简单地将其复制到一个名为.git/hooks/pre-commit
.
的可执行文件中
检查分支名称有点棘手。这确实应该在您创建分支名称时发生,而不是在您提交它时发生,并且不可能在客户端上做得很好 - 它必须在具有适当全局视图的集中式服务器上完成。
这是一种在服务器上使用预接收脚本执行此操作的方法,使用 shell 脚本而不是 Python(如链接的答案)。不过,我们仍然需要 checkstdin
函数,您可能希望在更新挂钩而不是预接收挂钩中执行此操作,因为您不需要拒绝 entire push,只有一个分支名称。
NULLSHA=0000000000000000000000000000000000000000 # 40 0s
# Verify that the given branch name 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 ""; git for-each-ref --format='%(refname:short)' refs/heads) |
checkstdin || {
echo "ERROR: new branch name 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
我们在混合环境中开发 - 有些人在 Mac 上工作,有些人在 Linux 上工作。这有时被证明是一个挑战,因为那些在 Linux 上工作的人习惯于让他们的文件系统区分大小写,所以提交(意外或其他)多个文件只是大小写不同是没有问题的. (例如 FileName.ext
与 filename.ext
)
但是,当使用 Mac 的人去检查存储库时,拥有不区分大小写的文件系统意味着这两个文件(仅大小写不同)会相互覆盖并造成全面破坏。
我知道有多种 git 设置可以帮助使用不区分大小写的文件系统的人更好地处理大小写更改(例如 core.ignorecase
),但是这些设置并不能解决有两个问题的问题存储库中的不同文件,仅大小写不同。
我意识到修复它的唯一方法是确保 Linux 人们不会首先提交两个仅大小写不同的文件。 -- git 中是否有某些设置会在区分大小写的文件系统上的用户尝试提交在不区分大小写的文件系统上会相互混淆的文件时弹出警告或错误?
没有内置任何东西(尽管应该有,毫无疑问)。您可以做的是提供一个预提交挂钩,验证所有名称是否正确,如果不正确则阻止提交。
这个钩子只需要 运行 在 Linux 框上(尽管让它在 Linux 和 Mac 上工作很容易,它只是 Windows 其默认的贫乏工具箱是有问题的)。您可能想将它添加到侧分支并向 Linux 人员提供有关设置它的说明。
您可能还想检查分支 names,就像在
首先,让我们编写一个"check for case conflict"函数。这只是大小写排序的问题(因此 "helloworld" 和 "helloWorld" 彼此相邻放置),然后使用 uniq -di
打印任何重复项(大小写折叠后)字符串,但没有非重复项:
sort -f | uniq -di
如果这产生任何输出,这些是 "bad names"。让我们将输出捕获到一个临时文件中并检查其大小,以便我们也可以将它们打印到标准输出:
#! /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
只检查 添加的 文件,允许现有的案例冲突继续,and/or 尝试跨检查许多分支 and/or 提交,但这变得困难。
将以上两个片段合并成一个脚本(并测试),然后简单地将其复制到一个名为.git/hooks/pre-commit
.
检查分支名称有点棘手。这确实应该在您创建分支名称时发生,而不是在您提交它时发生,并且不可能在客户端上做得很好 - 它必须在具有适当全局视图的集中式服务器上完成。
这是一种在服务器上使用预接收脚本执行此操作的方法,使用 shell 脚本而不是 Python(如链接的答案)。不过,我们仍然需要 checkstdin
函数,您可能希望在更新挂钩而不是预接收挂钩中执行此操作,因为您不需要拒绝 entire push,只有一个分支名称。
NULLSHA=0000000000000000000000000000000000000000 # 40 0s
# Verify that the given branch name 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 ""; git for-each-ref --format='%(refname:short)' refs/heads) |
checkstdin || {
echo "ERROR: new branch name 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