`git rm --cached`：如何让文件“脱离”版本控制

文章目录

• • • [文章：深入理解 `git rm --cached`：如何优雅地让文件"脱离"版本控制](#文章：深入理解 git rm --cached：如何优雅地让文件“脱离”版本控制)
    • • [**问题的根源：当 `.gitignore` "为时已晚"**](#问题的根源：当 .gitignore “为时已晚”)
      • [**`git rm --cached`：精准的"反向操作"**](#git rm --cached：精准的“反向操作”)
      • [**实战演练：如何正确使用 `git rm --cached`**](#实战演练：如何正确使用 git rm --cached)
      • [**与 `git rm` 的区别**](#与 git rm 的区别)
    • 命令解析
    • • **结论**

文章：深入理解 git rm --cached：如何优雅地让文件"脱离"版本控制

在日常使用 Git 进行版本控制的过程中，我们有时会遇到这样的情况：不小心将一个本不应该提交的文件添加到了版本库中。这可能是编译生成的二进制文件、包含敏感信息的配置文件、或是体积庞大的日志文件。当你意识到这个问题时，你希望 Git 停止跟踪它，但又想在本地保留这个文件以供使用。这时，git rm --cached 命令就派上了用场。

问题的根源：当 .gitignore "为时已晚"

许多开发者都知道，可以通过配置 .gitignore 文件来告诉 Git 哪些文件或目录应该被忽略。但 .gitignore 只能忽略那些从未被跟踪过的文件。如果一个文件已经被 git add 和 git commit 过，那么即使你后来在 .gitignore 中添加了它，Git 仍然会继续跟踪它的变化。

例如，命令 git rm -r --cached .\bl_lib\qboot\tools\patch.rbl.bin 很可能就是在处理一个类似 patch.rbl.bin 的二进制文件，这种文件通常是编译生成的，不应该纳入版本控制。

git rm --cached：精准的"反向操作"

git rm --cached 可以看作是 git add 的一个反向操作。 git add 将文件放入暂存区以备提交，而 git rm --cached 则将文件从暂存区中移除，同时保留在你的工作目录中。

这个命令的典型应用场景包括：

1. 移除误提交的文件：最常见的场景就是移除非必需的文件，比如日志文件、IDE 配置文件、编译产物或包含密码等敏感信息的文件。
2. 使 .gitignore 规则生效 ：如果你想让一个已被跟踪的文件被 .gitignore 规则忽略，你需要先手动将其从 Git 的跟踪列表中移除。
3. 分离代码与配置：在团队协作中，某些配置文件可能因个人开发环境不同而有所差异。你可以提供一个配置模板，然后让团队成员复制并自行修改。为了避免个人的配置被提交，就应该使用此命令将其从版本控制中移除。

实战演练：如何正确使用 git rm --cached

让我们通过一个完整的工作流程，来看看如何处理一个已经被错误跟踪的文件。

第一步：从 Git 跟踪中移除文件

假设我们要移除上文提到的 patch.rbl.bin 文件。执行以下命令：

git rm -r --cached .\patch.rbl.bin

执行后，使用 git status 查看状态，你会看到提示该文件已被"删除"（deleted），这意味着它已经被移出暂存区。

第二步：更新 .gitignore 文件（推荐）

为了防止你或其他协作者未来再次不小心将这个文件添加进版本库，最佳实践是立即更新 .gitignore 文件，添加相应的忽略规则。

打开项目根目录下的 .gitignore 文件，添加一行：

/patch.rbl.bin

或者更通用的规则，比如忽略所有 .bin 文件：

*.bin```

**第三步：提交变更**

现在，提交你的修改来完成整个过程。

```bash
git commit -m "Stop tracking patch.rbl.bin and update .gitignore"

完成这次提交后，patch.rbl.bin 就彻底从 Git 的版本历史中"消失"了（指未来的提交中不再包含它），但它依然安静地躺在你的本地文件夹里。

与 git rm 的区别

需要特别注意的是，git rm 命令如果不带 --cached 参数，它不仅会从暂存区移除文件，还会直接从你的本地工作目录中删除该文件。 这是一个破坏性的操作，因此在使用前请务必确认你的意图。

命令	作用于暂存区	作用于工作目录
git rm <file>	✅ 移除	✅ 删除
git rm --cached <file>	✅ 移除	❌ 保留

命令解析

首先，我们来分解这个命令的各个部分，以便理解其确切含义：

• git rm: 这是 Git 中用于删除文件的基本命令。它可以从工作目录和索引（暂存区）中删除文件。
• -r : 这是 "recursive"（递归）的缩写。当目标是目录时，这个选项会递归地删除目录下的所有文件和子目录。在这个具体命令中，虽然目标是一个文件，但加上 -r 也没有负面影响。
• --cached : 这是一个非常关键的选项。它告诉 git rm 仅从索引（暂存区）中删除文件，但保留工作目录中的文件。换句话说，文件会从 Git 的跟踪列表中移除，但它仍然会留在你的本地文件系统中。
• .\patch.rbl.bin : 这是要操作的文件的相对路径。它指向当前目录下 tools\ 文件夹中的 patch.rbl.bin 文件。

总结起来，这个命令的整体作用是：

将 patch.rbl.bin 这个文件从 Git 的版本控制中移除（不再跟踪），但仍然将它保留在你的本地电脑上。

执行此命令后，当你提交这次变更，这个文件将从版本库中被删除。其他人更新代码时，他们本地的这个文件也会被删除（如果他们之前有的话）。而你本地的这个文件会变成一个未被跟踪的文件。

---

结论

git rm --cached 是一个强大而实用的工具，它为开发者提供了一种灵活的方式来管理版本库中的文件。通过将文件从版本控制中解绑，同时保留本地副本，它完美解决了误提交文件以及让 .gitignore 规则对已跟踪文件生效的难题，是每一位 Git 用户都应该掌握的重要命令。