简体中文 ▾ 主题 ▾ 最新版本 ▾ git-bisect 上次更新于 2.50.0

名称

git-bisect - 使用二分查找来找出引入 bug 的提交

概要

git bisect <subcommand> <options>

描述

该命令接受不同的子命令，并且根据子命令的不同，选项也不同

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 reset [<commit>]
git bisect (visualize|view)
git bisect replay <logfile>
git bisect log
git bisect run <cmd> [<arg>...]
git bisect help

此命令使用二分查找算法来找出项目中哪个提交引入了 bug。使用时，你首先需要指定一个已知包含该 bug 的“坏”提交，以及一个已知在 bug 引入之前的“好”提交。然后 git bisect 会在这两个端点之间选择一个提交，并询问你选定的提交是“好”还是“坏”。它会继续缩小范围，直到找到引入该更改的确切提交。

实际上，git bisect 可以用来找出改变了项目任何属性的提交；例如，修复 bug 的提交，或导致基准测试性能提升的提交。为了支持这种更通用的用法，可以使用“旧”和“新”来代替“好”和“坏”，或者你可以选择自己的术语。更多信息请参阅下面的“替代术语”一节。

基本二分查找命令：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 将会让你停留在当前的二分查找提交上，完全避免切换提交。

替代术语

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

在这种情况下，使用“好”和“坏”来指代“更改之前的状态”和“更改之后的状态”可能会非常混乱。因此，你可以分别使用“旧”和“新”来代替“好”和“坏”。（但请注意，在单个会话中不能混用“好”/“坏”和“旧”/“新”）。

在这种更通用的用法中，你向 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 可用于了解如何称呼比所查找的更改更新的提交。

如果你想使用自己的术语代替“坏”/“好”或“新”/“旧”，你可以选择任何你喜欢的名称（除了像 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 <旧术语> 和 git bisect <新术语> 来标记提交，而不是 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（包括 v2.6）之间的所有提交都不应被测试。

请注意，如果你也想跳过该范围的第一个提交，你需要执行以下命令：

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

这会告诉二分查找过程，v2.5 和 v2.6 之间的提交（包括两者）都应该被跳过。

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

如果你知道正在追查的问题涉及代码树的哪个部分，可以通过在执行 bisect start 命令时指定路径规范参数来进一步减少尝试次数：

$ 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 作为此目的的最高合理值，因为 126 和 127 被 POSIX shell 用于指示特定错误状态（127 表示命令未找到，126 表示命令找到但不可执行——​这些细节无关紧要，因为它们是脚本中的正常错误，就 bisect run 而言）。

你可能经常发现在二分查找会话期间，你希望对正在测试的修订版本应用临时修改（例如在头文件中将 s/#define DEBUG 0/#define DEBUG 1/，或者“没有此提交的修订版本需要应用此补丁以解决二分查找不感兴趣的另一个问题”）。

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

选项

--no-checkout

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

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

如果仓库是裸仓库，则假定使用 --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。

    为了防止二分查找、make 和测试过程以及脚本之间的相互作用，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] 套件的一部分

scroll-to-top