简体中文 ▾ 主题 ▾ 最新版本 ▾ git-bisect 最后更新于 2.52.0

名称

git-bisect - 使用二分查找定位引入 bug 的提交

概要

git bisect start [--term-(bad|new)=<term-new> --term-(good|old)=<term-old>]
		   [--no-checkout] [--first-parent] [<bad> [<good>…​]] [--] [<pathspec>…​]
git bisect (bad|new|<term-new>) [<rev>]
git bisect (good|old|<term-old>) [<rev>…​]
git bisect terms [--term-(good|old) | --term-(bad|new)]
git bisect skip [(<rev>|<range>)…​]
git bisect next
git bisect reset [<commit>]
git bisect (visualize|view)
git bisect replay <logfile>
git bisect log
git bisect run <cmd> [<arg>…​]
git bisect help

描述

此命令使用二分查找算法来查找项目历史中哪个提交引入了 bug。使用时，首先告诉它一个已知包含 bug 的“坏”（bad）提交，以及一个已知在 bug 引入之前的“好”（good）提交。然后 git bisect 会在这两个端点之间选择一个提交，并询问你该提交是“好”还是“坏”。它会不断缩小范围，直到找到引入该变更的确切提交。

实际上，git bisect 可以用来查找改变项目任何属性的提交；例如，修复 bug 的提交，或导致基准测试性能提升的提交。为了支持这种更通用的用法，可以使用术语“旧”（old）和“新”（new）来代替“好”和“坏”，或者你也可以选择自己的术语。详情请参阅下文“替代术语”部分。

基础二分查找命令：start, bad, good

举个例子，假设你正在寻找是哪个提交破坏了一个在项目 v2.6.13-rc2 版本中尚能正常运行的功能。你可以如下启动二分查找会话：

$ git bisect start
$ git bisect bad                 # Current version is bad
$ git bisect good v2.6.13-rc2    # v2.6.13-rc2 is known to be good

一旦你指定了至少一个坏提交和一个好提交，git bisect 就会在该历史范围的中间选择一个提交，将其检出，并输出类似以下的内容：

Bisecting: 675 revisions left to test after this (roughly 10 steps)

现在你应该编译检出的版本并进行测试。如果该版本运行正常，请输入：

$ git bisect good

如果该版本已损坏，请输入：

$ git bisect bad

然后 git bisect 会响应类似以下的内容：

Bisecting: 337 revisions left to test after this (roughly 9 steps)

不断重复此过程：编译代码树，进行测试，并根据结果是好是坏运行 git bisect good 或 git bisect bad 来获取下一个需要测试的提交。

最终将没有更多修订版本可供检查，该命令将打印出第一个坏提交的描述。引用 refs/bisect/bad 将指向该提交。

二分查找重置

在二分查找会话结束后，要清理二分查找状态并返回到原始 HEAD，请执行以下命令：

$ git bisect reset

默认情况下，这会将你的代码树返回到执行 git bisect start 之前检出的提交。（新的 git bisect start 也会这样做，因为它会清理旧的二分查找状态。）

通过可选参数，你可以返回到另一个不同的提交：

$ git bisect reset <commit>

例如，git bisect reset bisect/bad 将检出第一个坏的修订版本，而 git bisect reset HEAD 将让你留在当前的二分查找提交上，完全避免切换提交。

替代术语

有时你寻找的不是引入故障的提交，而是导致某些其他“旧”状态和“新”状态之间发生变化的提交。例如，你可能在寻找引入特定修复的提交。或者你可能在寻找第一个将源代码文件名全部转换为公司命名标准的提交。诸如此类。

在这种情况下，使用“好”和“坏”来指代“变更前的状态”和“变更后的状态”可能会让人非常困惑。因此，你可以分别使用术语“旧”（old）和“新”（new）来代替“好”和“坏”。（但请注意，你不能在单个会话中混合使用“好/坏”和“旧/新”。）

在这种更通用的用法中，你为 git bisect 提供一个具有某种属性的“新”提交和一个不具有该属性的“旧”提交。每次 git bisect 检出一个提交时，你都要测试该提交是否具有该属性。如果有，将该提交标记为“新”；否则，标记为“旧”。二分查找完成时，git bisect 将报告是哪个提交引入了该属性。

要使用“旧”和“新”代替“好”和“坏”，你必须运行不带提交参数的 git bisect start，然后运行以下命令来添加提交：

git bisect old [<rev>]

表示该提交在所寻求的变更之前，或者

git bisect new [<rev>...]

表示在变更之后。

要查看当前使用的术语提醒，请使用：

git bisect terms

你可以通过 git bisect terms --term-old 或 git bisect terms --term-good 仅获取旧术语；git bisect terms --term-new 和 git bisect terms --term-bad 可用于了解如何称呼比所寻求变更更近的提交。

如果你想使用自己的术语而不是“坏/好”或“新/旧”，你可以选择任何你喜欢的名称（除了现有的 bisect 子命令，如 reset、start 等），通过以下方式启动二分查找：

git bisect start --term-old <term-old> --term-new <term-new>

例如，如果你正在寻找引入性能退化的提交，你可以使用：

git bisect start --term-old fast --term-new slow

或者，如果你正在寻找修复 bug 的提交，你可以使用：

git bisect start --term-new fixed --term-old broken

然后，使用 git bisect <term-old> 和 git bisect <term-new> 代替 git bisect good 和 git bisect bad 来标记提交。

二分查找可视化/查看

要在 gitk 中查看当前剩余的嫌疑提交，请在二分查找过程中执行以下命令（子命令 view 可以作为 visualize 的替代方案）：

$ git bisect visualize

Git 通过各种环境变量检测图形环境：DISPLAY，在 Unix 系统的 X Window System 环境中设置。SESSIONNAME，在 Cygwin 的交互式桌面会话中设置。MSYSTEM，在 Msys2 和 Git for Windows 下设置。SECURITYSESSIONID，可能在 macOS 的交互式桌面会话中设置。

如果这些环境变量都没有设置，则改用 git log。你也可以提供命令行选项，如 -p 和 --stat。

$ git bisect visualize --stat

二分查找日志和重放

在将修订版本标记为好或坏之后，执行以下命令以显示到目前为止的操作：

$ git bisect log

如果你发现自己在指定修订版本状态时犯了错误，可以将此命令的输出保存到文件中，对其进行编辑以删除错误条目，然后执行以下命令以返回到正确的状态：

$ git bisect reset
$ git bisect replay that-file

避免测试某个提交

如果在二分查找会话中间，你发现建议的修订版本不适合测试（例如它无法编译，且你确定该失败与你追查的 bug 无关），你可以手动选择附近的一个提交并测试该提交。

例如

$ git bisect good/bad			# previous round was good or bad.
Bisecting: 337 revisions left to test after this (roughly 9 steps)
$ git bisect visualize			# oops, that is uninteresting.
$ git reset --hard HEAD~3		# try 3 revisions before what
					# was suggested

然后编译并测试选定的修订版本，之后按常规方式将该修订版本标记为好或坏。

二分查找跳过

除了自己选择附近的提交，你还可以通过执行以下命令让 Git 为你选择：

$ git bisect skip                 # Current version cannot be tested

但是，如果你跳过了与你寻找的提交相邻的提交，Git 将无法准确判断这些提交中哪一个是第一个坏提交。

你还可以使用范围表示法跳过一系列提交，而不仅仅是一个提交。例如：

$ git bisect skip v2.5..v2.6

这告诉二分查找过程：不应测试 v2.5 之后直到并包括 v2.6 的任何提交。

请注意，如果你还想跳过范围内的第一个提交，你应该执行命令：

$ git bisect skip v2.5 v2.5..v2.6

这告诉二分查找过程：应跳过 v2.5 到 v2.6（含）之间的提交。

下一步二分查找

通常，在将修订版本标记为好或坏之后，Git 会自动计算并检出下一个要测试的修订版本。但是，如果你需要显式请求下一个二分查找步骤，可以使用：

$ git bisect next

你可能会在检出其他修订版本导致二分查找中断后，使用此命令恢复二分查找过程。

通过为 bisect start 提供更多参数来缩减二分查找范围

如果你知道所追踪的问题涉及代码树的哪些部分，可以在执行 bisect start 命令时指定路径规范（pathspec）参数，从而进一步减少试验次数：

$ git bisect start -- arch/i386 include/asm-i386

如果你预先知道多个好提交，可以在执行 bisect start 命令时，在坏提交之后立即指定所有好提交，以缩小二分查找空间：

$ git bisect start v2.6.20-rc6 v2.6.20-rc4 v2.6.20-rc1 --
                   # v2.6.20-rc6 is bad
                   # v2.6.20-rc4 and v2.6.20-rc1 are good

二分查找自动运行

如果你有一个脚本可以判断当前源代码是好是坏，可以通过执行以下命令进行二分查找：

$ git bisect run my_script arguments

请注意，如果当前源代码是好/旧的，脚本（上述示例中的 my_script）应以退出代码 0 退出；如果当前源代码是坏/新的，应以 1 到 127 之间（含）的退出代码（125 除外）退出。

任何其他退出代码都会中止二分查找过程。应当注意，通过 exit(-1) 终止的程序会留下 $? = 255（参见 exit(3) 手册页），因为该值会被 & 0377 截断。

特殊的退出代码 125 应在当前源代码无法测试时使用。如果脚本以该代码退出，当前修订版本将被跳过（见上文 git bisect skip）。125 被选为用于此目的的最大合理值，因为 POSIX shell 使用 126 和 127 来发出特定错误状态信号（127 表示找不到命令，126 表示找到命令但不可执行——就 bisect run 而言，这些细节无关紧要，因为它们被视为脚本中的正常错误）。

你经常会发现在二分查找会话期间，你想对正在测试的修订版本进行临时修改（例如在头文件中将 #define DEBUG 0 修改为 #define DEBUG 1，或者“不包含此提交的修订版本需要应用此补丁以绕过本次二分查找不感兴趣的另一个问题”）。

为了应对这种情况，在内部 git bisect 找到下一个要测试的修订版本后，脚本可以在编译前应用补丁，运行真正的测试，然后决定修订版本（可能带有必要的补丁）是否通过测试，最后将代码树恢复到原始状态。最后，脚本应以真实测试的状态退出，让 git bisect run 命令循环确定二分查找会话的最终结果。

选项

--no-checkout

在二分查找过程的每次迭代中不检出新的工作树。相反，只需更新名为 BISECT_HEAD 的引用，使其指向应测试的提交。

当你每一步执行的测试不需要检出的代码树时，此选项可能很有用。

如果存储库是裸仓库（bare），则默认使用 --no-checkout。

--first-parent

在遇到合并提交时只关注第一个父提交。

在检测通过合并分支引入的退化时，合并提交将被识别为引入 bug 的提交，而其祖先将被忽略。

当合并的分支包含损坏或无法构建的提交，但合并本身是正常的时候，此选项在避免误报方面特别有用。

示例

  • 自动在 v1.2 和 HEAD 之间二分查找损坏的构建

    $ git bisect start HEAD v1.2 --      # HEAD is bad, v1.2 is good
$ git bisect run make                # "make" builds the app
$ git bisect reset                   # quit the bisect session

  • 自动在 origin 和 HEAD 之间二分查找测试失败

    $ git bisect start HEAD origin --    # HEAD is bad, origin is good
$ git bisect run make test           # "make test" builds and tests
$ git bisect reset                   # quit the bisect session

  • 自动对损坏的测试用例进行二分查找

    $ cat ~/test.sh
#!/bin/sh
make || exit 125                     # this skips broken builds
~/check_test_case.sh                 # does the test case pass?
$ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
$ git bisect run ~/test.sh
$ git bisect reset                   # quit the bisect session

    这里我们使用一个 test.sh 自定义脚本。在此脚本中，如果 make 失败，我们就跳过当前提交。如果测试用例通过，check_test_case.sh 应 exit 0，否则 exit 1。

    为了防止二分查找、编译和测试过程与脚本之间发生冲突，将 test.sh 和 check_test_case.sh 放在存储库之外会更安全。

  • 使用临时修改（热修复）进行自动二分查找

    $ cat ~/test.sh
#!/bin/sh

# tweak the working tree by merging the hot-fix branch
# and then attempt a build
if	git merge --no-commit --no-ff hot-fix &&
	make
then
	# run project specific test and report its status
	~/check_test_case.sh
	status=$?
else
	# tell the caller this is untestable
	status=125
fi

# undo the tweak to allow clean flipping to the next commit
git reset --hard

# return control
exit $status

    这会在每次测试运行前应用来自热修复分支的修改，例如，如果你的构建或测试环境发生了变化，导致较旧的修订版本可能需要较新版本中已有的修复。（确保热修复分支基于一个包含在你正在二分查找的所有修订版本中的提交，这样合并就不会引入过多内容，或者使用 git cherry-pick 代替 git merge。）

  • 自动对损坏的测试用例进行二分查找

    $ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
$ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"
$ git bisect reset                   # quit the bisect session

    这表明如果你将测试写在一行中，就不需要运行脚本。

  • 在损坏的存储库中定位对象图的一个良好区域

    $ git bisect start HEAD <known-good-commit> [ <boundary-commit> ... ] --no-checkout
$ git bisect run sh -c '
	GOOD=$(git for-each-ref "--format=%(objectname)" refs/bisect/good-*) &&
	git rev-list --objects BISECT_HEAD --not $GOOD >tmp.$$ &&
	git pack-objects --stdout >/dev/null <tmp.$$
	rc=$?
	rm -f tmp.$$
	test $rc = 0'

$ git bisect reset                   # quit the bisect session

    在这种情况下，当 git bisect run 结束时，bisect/bad 将指向一个提交，该提交至少有一个父提交，其可达图在 git pack objects 所需的意义上是完全可遍历的。

  • 寻找代码中的修复而不是退化

    $ git bisect start
$ git bisect new HEAD    # current commit is marked as new
$ git bisect old HEAD~10 # the tenth commit from now is marked as old

    或

    $ git bisect start --term-old broken --term-new fixed
$ git bisect fixed
$ git bisect broken HEAD~10

获取帮助

使用 git bisect 获取简短的使用说明，使用 git bisect help 或 git bisect -h 获取详细的使用说明。

另请参阅

使用 git bisect 对抗退化，git-blame[1]。

GIT

Git[1] 套件的一部分