git - 带有“git commit”的意外行为。预提交 Hook 修改暂存文件时

Question

以我的经验，git commit -a具有与git commit .相同的行为，但是，最近，我创建了一个pre-commit钩子，该钩子会自动格式化我的源代码，现在git commit .具有一些意外的副作用：提交的文件最终结束了在commit命令完成后，在工作目录和索引中进行修改。 git commit -a不会发生这种情况。我试图了解运行git commit .时幕后发生的情况，这是导致这种情况发生的原因，并查看是否存在在预提交的钩子脚本中正确处理该问题的方法。

预提交钩子：

git_toplevel=$(git rev-parse --show-toplevel)

git --no-pager diff -z --cached --name-only --diff-filter=ACMRT | $git_toplevel/meta/reformat.bash -s files
git --no-pager diff -z --name-only --diff-filter=ACMRT | xargs -0 --no-run-if-empty git add

当前使用的是git版本1.8.3.1，但在最新版本中却看到了相同的行为。

这是在行的开头添加一个简单空格的命令序列：

[]$ git status
# On branch eroller/format-clean-filter
# Your branch is ahead of 'origin/eroller/format-clean-filter' by 1 commit.
#   (use "git push" to publish your local commits)
#
# Changes not staged for commit:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#       modified:   src/host/cnv/denovo/denovo_cnv.cpp
#
no changes added to commit (use "git add" and/or "git commit -a")

--

[]$ git diff
diff --git a/src/host/cnv/denovo/denovo_cnv.cpp b/src/host/cnv/denovo/denovo_cnv.cpp
index 7cfb8dc..14058e3 100644
--- a/src/host/cnv/denovo/denovo_cnv.cpp
+++ b/src/host/cnv/denovo/denovo_cnv.cpp
@@ -28,7 +28,7 @@ using namespace std;
 namespace cnv {
 namespace denovo {

-SegmentsBySample LoadCallsForSamples(const vector<string>& callFiles, const ReferenceDictionary& reference)
+ SegmentsBySample LoadCallsForSamples(const vector<string>& callFiles, const ReferenceDictionary& reference)
 {
   function<SegmentsBySample::value_type(const string&)> loadCalls = [&](string callFile) {
     return LoadCalls(callFile, reference);

--

[]$ git commit -m 'test' .

--

[]$ git status
# On branch eroller/format-clean-filter
# Your branch is ahead of 'origin/eroller/format-clean-filter' by 2 commits.
#   (use "git push" to publish your local commits)
#
# Changes to be committed:
#   (use "git reset HEAD <file>..." to unstage)
#
#       modified:   src/host/cnv/denovo/denovo_cnv.cpp
#
# Changes not staged for commit:
#   (use "git add <file>..." to update what will be committed)
#   (use "git checkout -- <file>..." to discard changes in working directory)
#
#       modified:   src/host/cnv/denovo/denovo_cnv.cpp
#

--

[]$ git diff
diff --git a/src/host/cnv/denovo/denovo_cnv.cpp b/src/host/cnv/denovo/denovo_cnv.cpp
index 14058e3..7cfb8dc 100644
--- a/src/host/cnv/denovo/denovo_cnv.cpp
+++ b/src/host/cnv/denovo/denovo_cnv.cpp
@@ -28,7 +28,7 @@ using namespace std;
 namespace cnv {
 namespace denovo {

- SegmentsBySample LoadCallsForSamples(const vector<string>& callFiles, const ReferenceDictionary& reference)
+SegmentsBySample LoadCallsForSamples(const vector<string>& callFiles, const ReferenceDictionary& reference)
 {
   function<SegmentsBySample::value_type(const string&)> loadCalls = [&](string callFile) {
     return LoadCalls(callFile, reference);

--

[]$ git diff --cached
diff --git a/src/host/cnv/denovo/denovo_cnv.cpp b/src/host/cnv/denovo/denovo_cnv.cpp
index 7cfb8dc..14058e3 100644
--- a/src/host/cnv/denovo/denovo_cnv.cpp
+++ b/src/host/cnv/denovo/denovo_cnv.cpp
@@ -28,7 +28,7 @@ using namespace std;
 namespace cnv {
 namespace denovo {

-SegmentsBySample LoadCallsForSamples(const vector<string>& callFiles, const ReferenceDictionary& reference)
+ SegmentsBySample LoadCallsForSamples(const vector<string>& callFiles, const ReferenceDictionary& reference)
 {
   function<SegmentsBySample::value_type(const string&)> loadCalls = [&](string callFile) {
     return LoadCalls(callFile, reference);

更新：使用@torek的非常详尽的答案（谢谢！），如果用户尝试使用 git commit .或 git commit [--only] -- <files>，我决定在预提交挂钩中给出错误。这是我的预提交脚本中的检查内容：

if [[ $GIT_INDEX_FILE != *"/index" ]] && [[ $GIT_INDEX_FILE != *"/index.lock" ]] ; then
  echo "Error: pre-commit reformatting using unsupported index file ($GIT_INDEX_FILE)." >&2
  echo "       Are you using 'git commit [--only] -- <files>' to bypass staging?" >&2
  echo "       Use git commit -a or stage your files before committing using git add -- <files>" >&2
  echo "       Use '--no-verify' to bypass reformatting (not recommended)" >&2
  exit 1
fi

Answer 1

这里的根本问题是，Git并不是从工作树而是从索引进行提交，这就是为什么首先需要git add文件的原因-但是索引是一种白色谎言，因为可以有更多的谎言索引文件不仅仅是一种标准文件。 （该索引也称为暂存区域或缓存，具体取决于Git的哪一部分正在执行调用。）
索引（我指的是一个标准索引）是.git中名为index的文件。如果检查您的.git目录，则会找到这样的文件。过去，实际上只有一个文件。在现代Git（2.5或更高版本）中，由于添加了工作树，因此画面变得更加模糊：实际上每个工作树只有一个索引文件，因此.git/index只是主工作树的索引。每个工作树都有一个辅助索引-但这并不是我要表达的意思，这里，这只是一个例子，它显示了一个单一索引的假设已经在边缘发生了变化。诚然，您使用的是Git 1.8.3.1（确实很旧），但它也比简单的白色谎言“一个索引”设置更为复杂。
使用git commit -a时，Git会创建一个新的额外索引。使用git commit .时，您要调用git commit --only .（see the documentation for details），Git会创建两个新的额外索引（索引？）。
Git的所有部分都能够重定向Git的其余部分以使用不同的非标准索引，并且git commit的这些各种选项均使用此功能。请注意，git commit -a等效于git commit --include，后跟需要添加的任何文件的名称。真正棘手的情况是您正在使用的git commit --only。
一旦开始增加索引文件，事情就会变得混乱！
请记住，索引本质上是建议的下一次提交。如果只有一个索引（对于这个工作树，如果我们正在谈论Git 2.5或更高版本），那么只有一个建议的下一次提交。不太困难，我们只需要考虑每个文件有三个副本即可。让我们选择一个文件，例如README.md：

HEAD:README.md是README.md的当前提交版本。您无法更改。 （您可以移动HEAD本身，但是README.md的已提交副本位于提交中，这是通过提交的哈希ID找到的，并且不会更改。）
名称HEAD:README.md仅在Git内部有效。该名称访问该文件的冻结，经过Git验证，冻结干燥的副本；此副本将永远不会改变。例如，您可以通过git show HEAD:README.md看到它。

:README.md是索引中README.md的副本。它最初与HEAD:README.md相同，但是如果您运行git add README.md，则现在可能有所不同。
名称:README.md也仅在Git内部有效。该名称将访问此可替换但已Git认证（冻结干燥格式）的文件副本，该副本存储在索引中。您可以随时用git add替换。

最后，README.md是普通（非Git认证）文件。它不在Git中！它不在索引中！它在您的工作树中，您可以使用所有普通的计算机工具来查看和处理它。 Git确实不使用此文件，它只是覆盖它或在您签出其他提交时将其删除。除了使用git status等进行检查之外，Git唯一要做的就是让您使用git add将其复制回索引，覆盖之前的内容（并在过程中将其冻干）。


运行git status运行两个git diff：

第一个将HEAD提交与索引进行比较，即当前提交中的内容与建议的下一次提交中的内容。此处列出的任何其他内容均已列为提交阶段。一切都一样，Git只是悄无声息。

第二个git diff将索引与工作树进行比较，即提议的提交中包含什么，以及可以复制到索引中的内容。此处列出的所有其他内容均未列为未提交。同样，再次，Git悄无声息。

（然后是最后一步，检查工作树中根本不在索引中的文件。Git会抱怨这些，说它们是未跟踪的，除非您在.gitignore中列出它们。在.gitignore不会更改索引中是否存在该文件的副本，而只会更改Git是否发牢骚。）


当您运行git commit时，除非您使用--only，--include或-a，否则Git会打包索引中的所有内容，并使用它来进行新的提交。
指数out the wazoo
使用git commit --only，Git可以创建三个索引文件：

一个是标准之一。一开始没有被改动。那是正常的.git/index。
一个是该副本的副本，其中--only文件已被git add对其进行复制。有时在.git/index.lock中。也许总是在这里！如果是这样，那将提供一种处理我在下面概述的情况的方法。但是没有文档可以保证这一点。
第三个是新的，首先提取HEAD，然后git add将--only文件添加到其中。

如果在运行git add之前没有任何git commit -a内容，则第一个索引文件和第三个索引文件会匹配，因为将--only文件添加到常规索引中的效果与从HEAD创建新的临时索引并添加--only文件。但是，否则所有三个文件可能都不同！
然后，Git从第三个索引进行新的提交。如果新的提交成功，则Git用第二个索引替换常规索引（此替换通过rename系统调用发生）。否则，Git返回正常索引。 （请注意，工作树什么都没有发生。）
如果使用git commit --include或git commit -a，则Git仅增加一个索引，因此您具有：

.git/index中的标准索引，以及到目前为止添加的内容；和
临时文件中的一个额外索引：该索引从标准索引的副本开始，但是随后Git将列出的文件或其他修改的文件添加到该索引中。

然后，Git启动提交过程。如果一切顺利，完成Git后，Git将重命名临时索引，使其成为标准索引。如果情况不佳，Git会删除临时索引，而标准索引保持不变。同样，工作树没有任何反应。
介绍预提交挂钩
在准备任何额外的索引文件之后，Git会运行您的预提交钩子。特殊的环境变量$GIT_INDEX_FILE为Git用来进行新提交的索引命名。因此，存在三种情况，其中两种情况还不错，而其中一种则很糟糕：

您正在执行常规提交。 GIT_INDEX_FILE命名普通索引，一切正常。
您正在执行git commit --include或git commit -a，并且GIT_INDEX_FILE命名第二个索引；没有第三索引；如果提交完成，Git将重命名第二个索引。
您正在执行git commit --only，并且GIT_INDEX_FILE命名第三个索引。找到第二个索引没有简单的方法，如果提交成功，第二个索引将在提交之后就位！

如果您选择对存储在索引中的文件进行更改，您的工作就是将它们更改为Git将用于提交的索引。为此，可以根据需要使用git add，因为这会将文件从工作树复制到$GIT_INDEX_FILE中命名的索引。
但是，第一个问题是您不能查看工作树中的文件。他们无关紧要！它们可能包含与索引中完全不同的内容。在git commit --only期间尤其如此。
第二个更大的问题是，如果您更新了git commit --only使用的第三个索引，则还应该更新git commit --only使用的第二个索引。这部分很棘手，因为除了假定它在.git/index.lock中之外，没有其他简单的方法可以找到它。尽管这可能会起作用，但在这里我不建议这样做。
我真的对此没有任何建议-您发现的任何偷偷摸摸的方法都可能会破坏，因为处理第三个索引的代码（当前的2.21 ish Git称为“假索引”）在1.8和现代Git之间已发生了很大变化。通常的最佳实践建议是根本不对Git挂钩进行任何特殊格式化。相反，让Git挂钩仅检查文件的索引副本是否格式正确：如果是，则继续提交，否则，放弃提交。其余的留给用户。
另一种选择
我已经看到和使用的替代方法是检查$GIT_INDEX_FILE的实际设置。如果将其设置为.git/index，则用户正在使用git commit，而没有任何特殊设置。 this same pre-commit hook中的另一个技巧（调用clang-format和autopep8）是比较将被格式化的文件的索引和工作树，并在它们不匹配时拒绝运行。