第二版

7.6 Git 工具 - 重写历史

重写历史

在使用 Git 时，你常常会想要修改本地的提交历史。Git 的一大优点是它允许你在最后一刻做出决定。你可以通过暂存区在提交前决定哪些文件进入哪些提交；你可以通过 git stash 决定暂时不处理当前的工作；你甚至可以在提交发生后重写它们，让它们看起来是以不同的方式完成的。这可能涉及到更改提交顺序、更改信息或修改提交中的文件、合并或拆分提交，甚至完全删除提交——所有这些都可以在你与他人分享你的工作之前完成。

在本节中，你将学习如何完成这些任务，以便在与他人分享之前，让你的提交历史呈现出你想要的样子。

注意	在对工作满意之前，不要推送（push）它 Git 的基本准则之一是：由于大部分工作都是在你本地的克隆版本中进行的，因此你有很大的自由度在本地重写历史。然而，一旦你推送了你的工作，情况就完全不同了。除非有充分的理由，否则你应该将已推送的工作视为最终版本。简而言之，你应该避免推送你的工作，直到你对其感到满意并准备好与全世界分享。

更改最后一次提交

更改最近一次提交可能是你最常进行的重写历史操作。你通常会对最后一次提交做两件基本的事情：简单地更改提交信息，或者通过添加、删除和修改文件来更改提交的实际内容。

如果你只是想修改最后一次提交的信息，这很简单

$ git commit --amend

上述命令会将之前的提交信息加载到编辑器会话中，你可以在其中更改信息、保存并退出。当你保存并关闭编辑器时，编辑器会写入一个新的提交，包含更新后的提交信息，并将其设为你最新的提交。

另一方面，如果你想更改最后一次提交的实际内容，过程基本相同——首先进行你认为遗漏的更改，暂存这些更改，随后的 git commit --amend 命令会用你这个新的、改进后的提交替换掉上一次的提交。

使用此技术时需要小心，因为修改（amend）会更改提交的 SHA-1 值。这就像是一次小型的变基（rebase）——如果已经推送了最后一次提交，就不要再修改它了。

提示	已修改的提交可能（也可能不需要）需要修改提交信息当你修改提交时，你有机会同时更改提交信息和提交内容。如果你大幅度修改了提交内容，几乎肯定应该更新提交信息以反映这些修改。另一方面，如果你的修改非常微小（例如修复一个简单的拼写错误或添加一个忘记暂存的文件），以至于之前的提交信息依然适用，你可以直接进行更改、暂存它们，并完全跳过不必要的编辑器会话，直接运行 `$ git commit --amend --no-edit`

更改多个提交信息

要修改历史中更靠前的提交，必须使用更复杂的工具。Git 没有直接修改历史的工具，但你可以使用变基（rebase）工具将一系列提交重新变基到它们原本所基于的 HEAD 之上，而不是将它们移动到另一个分支上。通过交互式变基工具，你可以在想要修改的每个提交后停止，更改信息、添加文件或做任何你想做的事。你可以通过在 git rebase 后添加 -i 选项来运行交互式变基。你必须通过告诉命令变基到哪个提交来指定你想重写多远的历史。

例如，如果你想更改最近三次提交的信息，或者更改该组中的任何提交信息，你需要向 git rebase -i 提供你想编辑的最后一个提交的父提交作为参数，即 HEAD~2^ 或 HEAD~3。记住 ~3 可能会更容易，因为你想编辑的是最后三个提交，但请记住，你实际上指定的是四个提交之前的那个，即你想编辑的最后一个提交的父提交。

$ git rebase -i HEAD~3

再次提醒，这是一个变基命令——HEAD~3..HEAD 范围内的每一个提交，如果更改了信息，及其所有后代提交都将被重写。不要包含任何你已经推送到中央服务器的提交——这样做会通过提供相同更改的替代版本来困扰其他开发者。

运行此命令会在文本编辑器中为你提供一个提交列表，看起来像这样

pick f7f3f6d Change my name a bit
pick 310154e Update README formatting and add blame
pick a5f4a0d Add cat-file

# Rebase 710f0f8..a5f4a0d onto 710f0f8
#
# Commands:
# p, pick <commit> = use commit
# r, reword <commit> = use commit, but edit the commit message
# e, edit <commit> = use commit, but stop for amending
# s, squash <commit> = use commit, but meld into previous commit
# f, fixup <commit> = like "squash", but discard this commit's log message
# x, exec <command> = run command (the rest of the line) using shell
# b, break = stop here (continue rebase later with 'git rebase --continue')
# d, drop <commit> = remove commit
# l, label <label> = label current HEAD with a name
# t, reset <label> = reset HEAD to a label
# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
# .       create a merge commit using the original merge commit's
# .       message (or the oneline, if no original merge commit was
# .       specified). Use -c <commit> to reword the commit message.
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out

需要注意的是，这些提交的顺序与你通常使用 log 命令看到的顺序相反。如果你运行 log，你会看到类似这样的结果

$ git log --pretty=format:"%h %s" HEAD~3..HEAD
a5f4a0d Add cat-file
310154e Update README formatting and add blame
f7f3f6d Change my name a bit

注意这里的反向顺序。交互式变基为你提供了一个它将要运行的脚本。它将从你在命令行中指定的提交（HEAD~3）开始，从上到下重放每个提交中引入的更改。它将最旧的提交列在最上面，而不是最新的，因为那是它要重放的第一个提交。

你需要编辑脚本，使其在你想要编辑的提交处停止。为此，将你想要脚本停止的每个提交前面的单词“pick”改为“edit”。例如，如果只修改第三个提交的信息，你可以将文件修改为这样

edit f7f3f6d Change my name a bit
pick 310154e Update README formatting and add blame
pick a5f4a0d Add cat-file

当你保存并退出编辑器时，Git 会将你回退到该列表中的最后一个提交，并在命令行中提示以下信息

$ git rebase -i HEAD~3
Stopped at f7f3f6d... Change my name a bit
You can amend the commit now, with

       git commit --amend

Once you're satisfied with your changes, run

       git rebase --continue

这些指令会准确告诉你该做什么。输入

$ git commit --amend

修改提交信息并退出编辑器。然后，运行

$ git rebase --continue

此命令将自动应用剩下的两个提交，然后你就完成了。如果你在多行上将 pick 改为 edit，你可以在每次更改为 edit 的提交后重复这些步骤。每次 Git 都会停止，让你修改提交，并在完成后继续。

重排提交

你也可以使用交互式变基来重排或完全删除提交。如果你想删除 “Add cat-file” 提交并更改其他两个提交的顺序，你可以将变基脚本从这样

pick f7f3f6d Change my name a bit
pick 310154e Update README formatting and add blame
pick a5f4a0d Add cat-file

修改为这样

pick 310154e Update README formatting and add blame
pick f7f3f6d Change my name a bit

当你保存并退出编辑器时，Git 会将你的分支回退到这些提交的父提交，应用 310154e，然后应用 f7f3f6d，接着停止。你实际上改变了这些提交的顺序，并完全删除了 “Add cat-file” 提交。

压缩（Squashing）提交

使用交互式变基工具，还可以将一系列提交压缩为一个提交。脚本在变基信息中提供了有用的说明

#
# Commands:
# p, pick <commit> = use commit
# r, reword <commit> = use commit, but edit the commit message
# e, edit <commit> = use commit, but stop for amending
# s, squash <commit> = use commit, but meld into previous commit
# f, fixup <commit> = like "squash", but discard this commit's log message
# x, exec <command> = run command (the rest of the line) using shell
# b, break = stop here (continue rebase later with 'git rebase --continue')
# d, drop <commit> = remove commit
# l, label <label> = label current HEAD with a name
# t, reset <label> = reset HEAD to a label
# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
# .       create a merge commit using the original merge commit's
# .       message (or the oneline, if no original merge commit was
# .       specified). Use -c <commit> to reword the commit message.
#
# These lines can be re-ordered; they are executed from top to bottom.
#
# If you remove a line here THAT COMMIT WILL BE LOST.
#
# However, if you remove everything, the rebase will be aborted.
#
# Note that empty commits are commented out

如果你指定 “squash” 而不是 “pick” 或 “edit”，Git 会应用该更改及其直接前方的更改，并让你合并这两个提交信息。因此，如果你想从这三个提交中创建一个单一的提交，你可以让脚本看起来像这样

pick f7f3f6d Change my name a bit
squash 310154e Update README formatting and add blame
squash a5f4a0d Add cat-file

当你保存并退出编辑器时，Git 会应用所有三个更改，然后让你回到编辑器中合并这三个提交信息

# This is a combination of 3 commits.
# The first commit's message is:
Change my name a bit

# This is the 2nd commit message:

Update README formatting and add blame

# This is the 3rd commit message:

Add cat-file

保存后，你就拥有了一个单一的提交，其中包含了之前三个提交的所有更改。

拆分提交

拆分提交会撤销一个提交，然后根据你想最终得到的提交数量，进行部分暂存和提交。例如，假设你想拆分三个提交中的中间那个。你不想保留 “Update README formatting and add blame”，而是想把它拆分为两个提交：“Update README formatting” 作为第一个，“Add blame” 作为第二个。你可以在 rebase -i 脚本中通过将你想拆分的提交指令改为 “edit” 来实现

pick f7f3f6d Change my name a bit
edit 310154e Update README formatting and add blame
pick a5f4a0d Add cat-file

然后，当脚本将你带到命令行时，你重置该提交，获取被重置的更改，并从中创建多个提交。当你保存并退出编辑器时，Git 会回退到列表中的第一个提交的父提交，应用第一个提交（f7f3f6d），应用第二个（310154e），并将你带到控制台。在那里，你可以使用 git reset HEAD^ 对该提交进行混合重置，这会有效地撤销该提交并将修改后的文件保持在未暂存状态。现在你可以暂存和提交文件，直到拥有多个提交，完成时运行 git rebase --continue

$ git reset HEAD^
$ git add README
$ git commit -m 'Update README formatting'
$ git add lib/simplegit.rb
$ git commit -m 'Add blame'
$ git rebase --continue

Git 会应用脚本中的最后一个提交（a5f4a0d），你的历史记录看起来就像这样

$ git log -4 --pretty=format:"%h %s"
1c002dd Add cat-file
9b29157 Add blame
35cfb2b Update README formatting
f7f3f6d Change my name a bit

这会更改你列表中最近三个提交的 SHA-1 值，因此请确保列表中没有任何已推送到共享仓库的更改。请注意，列表中的最后一个提交（f7f3f6d）没有改变。尽管此提交显示在脚本中，但因为它被标记为 “pick” 且在任何变基更改之前就被应用了，Git 会保持该提交不变。

删除提交

如果你想摆脱一个提交，可以使用 rebase -i 脚本删除它。在提交列表中，在你想删除的提交前加上单词 “drop”（或者直接从变基脚本中删除该行）

pick 461cb2a This commit is OK
drop 5aecc10 This commit is broken

由于 Git 构建提交对象的方式，删除或更改一个提交会导致其后的所有提交都被重写。在仓库历史中回溯得越远，需要重建的提交就越多。如果序列中有很多后续提交依赖于你刚刚删除的那个，这可能会导致大量的合并冲突。

如果你在变基过程中途决定这不是一个好主意，你可以随时停止。输入 git rebase --abort，你的仓库将恢复到变基开始之前的状态。

如果你完成了变基并决定这不是你想要的，可以使用 git reflog 来恢复分支的早期版本。有关 reflog 命令的更多信息，请参阅数据恢复。

注意	Drew DeVault 制作了一份实用的动手指南，包含练习来学习如何使用 `git rebase`。你可以在这里找到它：https://git-rebase.io/

核弹级选项：filter-branch

如果你需要以某种脚本方式重写大量提交（例如全局更改电子邮件地址或从每个提交中删除一个文件），还有另一个重写历史的选项。该命令是 filter-branch，它可以重写你历史记录中的大量内容，所以除非你的项目尚未公开，并且其他人没有基于你即将重写的提交进行工作，否则你不应该使用它。然而，它非常有用。你将学习一些常见的用法，以便了解它能实现的一些功能。

警告	`git filter-branch` 有很多陷阱，不再是推荐的重写历史方式。建议改用 `git-filter-repo`，这是一个 Python 脚本，在大多数你通常会使用 `filter-branch` 的情况下表现更好。其文档和源代码可在 https://github.com/newren/git-filter-repo 找到。

从每个提交中删除一个文件

这种情况相当普遍。有人不小心用随意的 git add . 提交了一个巨大的二进制文件，而你希望从各处删除它。也许你不小心提交了一个包含密码的文件，并希望将项目开源。filter-branch 很可能是你想要用来清理整个历史记录的工具。要从整个历史中删除名为 passwords.txt 的文件，你可以对 filter-branch 使用 --tree-filter 选项

$ git filter-branch --tree-filter 'rm -f passwords.txt' HEAD
Rewrite 6b9b3cf04e7c5686a9cb838c3f36a8cb6a0fc2bd (21/21)
Ref 'refs/heads/master' was rewritten

--tree-filter 选项在每次检出项目后运行指定的命令，然后重新提交结果。在这种情况下，无论是否存在 passwords.txt 文件，都会从每个快照中将其删除。如果你想删除所有不小心提交的编辑器备份文件，可以运行类似 git filter-branch --tree-filter 'rm -f *~' HEAD 的命令。

你将能够观察 Git 重写树和提交，并在最后移动分支指针。通常最好在测试分支中执行此操作，并在确定结果是你真正想要的之后，对你的 master 分支进行硬重置。要在所有分支上运行 filter-branch，你可以向命令传递 --all。

假设你从其他版本控制系统导入了项目，并且有一些没有意义的子目录（trunk、tags 等）。如果你想让 trunk 子目录成为每个提交的新项目根目录，filter-branch 也可以帮助你实现

$ git filter-branch --subdirectory-filter trunk HEAD
Rewrite 856f0bf61e41a27326cdae8f09fe708d679f596f (12/12)
Ref 'refs/heads/master' was rewritten

现在，你的新项目根目录就是每次提交中 trunk 子目录里的内容。Git 还会自动删除那些没有影响到该子目录的提交。

全局更改电子邮件地址

另一种常见情况是你忘记运行 git config 来设置姓名和电子邮件地址就开始工作了，或者你可能想在工作中开源一个项目，并将所有的工作邮箱地址更改为个人邮箱。无论哪种情况，你都可以使用 filter-branch 批量更改多个提交中的电子邮件地址。你需要小心只更改你自己的电子邮件地址，因此使用 --commit-filter

$ git filter-branch --commit-filter '
        if [ "$GIT_AUTHOR_EMAIL" = "schacon@localhost" ];
        then
                GIT_AUTHOR_NAME="Scott Chacon";
                GIT_AUTHOR_EMAIL="schacon@example.com";
                git commit-tree "$@";
        else
                git commit-tree "$@";
        fi' HEAD

这会遍历并重写每个提交以包含你的新地址。因为提交包含了其父提交的 SHA-1 值，此命令会更改你历史记录中的每个提交 SHA-1，而不仅仅是那些有匹配电子邮件地址的提交。

1. 起步

2. Git 基础

3. Git 分支

4. 服务器上的 Git

5. 分布式 Git

6. GitHub

7. Git 工具

8. 定制 Git

9. Git 与其他系统

10. Git 内部原理

A1. 附录 A: Git 在其他环境

A2. 附录 B: 在应用程序中嵌入 Git

A3. 附录 C: Git 命令