通过 git filter-branch 调用时反直觉的 git rm --cached 标志行为（追溯 .gitignore）

Question

问题

--cached 标志在通过git filter-branch --index-filter 运行git rm 时有何不同？

git filter-branch --index-filter 'git rm --cached *.ext'  
git filter-branch --index-filter 'git rm *.ext'

---

问题

当我运行git rm --cached *.ext 时，所有*.ext 文件都未跟踪但没有从工作目录中删除（据我了解，这是--cached 标志的目的）

但是，当我尝试追溯运行该命令时，就像

git filter-branch --index-filter 'git rm --cached *.ext'

所有历史 *.ext 文件均未跟踪并且现有 *.ext 文件已从工作目录中删除。

为什么？

没有--cached有什么区别

理论

由于该命令在所有提交上运行，每次运行都没有“工作目录”，因此它还将 HEAD/当前工作目录视为没有工作目录的独立提交。

Answer 1

您的理论大部分是正确的，只是在最后有点偏离。 git filter-branch 不使用标准索引，也不使用您的工作树。当它调用您的每个过滤器时，它会在一个临时目录中运行，该目录在文件系统中的位置取决于您是否提供了 -d <em>directory</em> 选项。¹ 如果没有可用的工作树，所有索引过滤器git rm 操作应该使用--cached。² Filter-branch 还在临时目录中创建一个临时索引。这个临时索引在过滤的每一步都存在：它用于提取索引过滤器的提交，然后在索引过滤器修改它后进行新的提交。

完成所有过滤操作后，filter-branch的最后几个步骤是：

1. 更新所有要修改的引用：过滤的分支和任何标签，如果你使用了--tag-name-filter。例如，master 之前可能已经识别了提交 a123456...。如果现在应该使用新的提交 b789abc... 而不是 a123456，则 Git 必须重写 refs/heads/master 以便它现在识别提交 b789abc...。

2. 如果您在非裸存储库中（过滤器分支 可以 用于裸存储库），则有效地git checkout 新提交而不是旧提交。这会更新您的索引和工作树，以便您的索引和工作树保持“干净”。³ 实际操作是 git read-tree：

   if [ "$(is_bare_repository)" = false ]; then
           git read-tree -u -m HEAD || exit
   fi
   

最后一步，即有效签出，会删除您的 *.ext 文件。

您的当前索引将它们显示为已跟踪，它们是；它们在您当前的commit 中，即（例如）a123456...。您的新目标提交b789abc... 缺少*.ext 文件，因为您使用--index-filter 过滤掉了它们。所以要从当前提交移动到新提交，正确的操作是删除文件。

解决问题：

运行git rm --cached '*.ext' 在您运行带有--index-filter 选项的filter-branch 命令并提交。这样，您的 current 提交（将不再是 a123456...）不会拥有这些文件，并且您的索引不会拥有这些文件，因此它们将只是在当前提交和新提交中都是未跟踪的文件，并且不会被触及。

---

¹Filter-branch 首先从您的-d 选项设置$tempdir，或默认设置.git-rewrite。然后它创建$tempdir/t，如果需要也创建$tempdir；将位置更改为其中；并将 Git 工作树设置为 .。此$tempdir/t 目录保持为空，除非您使用--tree-filter 选项，或者在任何过滤器中尝试以某种方式操作当前目录。

²如果没有--cached，git rm 会尝试从$GIT_WORK_TREE 中删除文件，即$tempdir/t。 Filter-branch 自己的状态文件从这里位于../，即$tempdir，因此它们通常应该是安全的，但尝试删除不应该存在的东西仍然不是一个好主意：如果仅此而已，它浪费了计算时间。使用--cached 可以防止git rm 尝试它。

³这里的“干净”是一种定义模糊的状态，无论如何您都可能认识它。如果需要，精确的定义在git-sh-setup.sh 中，特别是在函数require_clean_work_tree 中。如果在非裸存储库上运行，Filter-branch 在开始过滤之前调用它。