Git
章节 ▾ 第二版

7.10 Git 工具 - 使用 Git 进行调试

使用 Git 进行调试

除了主要用于版本控制之外，Git 还提供了一些命令来帮助你调试源代码项目。由于 Git 旨在处理几乎任何类型的內容，因此这些工具非常通用，但当出现问题时，它们通常可以帮助你查找错误或罪魁祸首。

文件注释

如果你在代码中发现了错误，并且想知道它是何时引入以及原因，文件注释通常是你的最佳工具。它会显示最后修改任何文件的每一行的提交。因此，如果你发现代码中的某个方法存在错误，可以使用 git blame 注释该文件以确定哪个提交导致了该行的引入。

以下示例使用 git blame 确定哪个提交和提交者负责 Linux 内核顶层 Makefile 中的某些行，并且进一步使用 -L 选项将注释的输出限制到该文件的第 69 行到第 82 行

$ git blame -L 69,82 Makefile
b8b0618cf6fab (Cheng Renquan  2009-05-26 16:03:07 +0800 69) ifeq ("$(origin V)", "command line")
b8b0618cf6fab (Cheng Renquan  2009-05-26 16:03:07 +0800 70)   KBUILD_VERBOSE = $(V)
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 71) endif
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 72) ifndef KBUILD_VERBOSE
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 73)   KBUILD_VERBOSE = 0
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 74) endif
^1da177e4c3f4 (Linus Torvalds 2005-04-16 15:20:36 -0700 75)
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 76) ifeq ($(KBUILD_VERBOSE),1)
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 77)   quiet =
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 78)   Q =
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 79) else
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 80)   quiet=quiet_
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 81)   Q = @
066b7ed955808 (Michal Marek   2014-07-04 14:29:30 +0200 82) endif

请注意，第一个字段是最后修改该行的提交的 SHA-1 的一部分。接下来的两个字段是从该提交中提取的值——提交者的姓名和提交日期——因此你可以轻松地查看谁修改了该行以及何时修改。之后是行号和文件的内容。还要注意 ^1da177e4c3f4 提交行，其中 ^ 前缀表示在存储库的初始提交中引入的行，并且从那时起就一直保持不变。这有点令人困惑，因为现在你已经看到了 Git 使用 ^ 修改提交 SHA-1 的至少三种不同方法，但这就是它在这里的含义。

Git 的另一个很酷的功能是它不会显式跟踪文件重命名。它记录快照，然后在事后尝试隐式地找出什么被重命名了。其中一个有趣的特性是你可以要求它找出所有类型的代码移动。如果你将 -C 传递给 git blame，Git 会分析你正在注释的文件，并尝试找出其中的代码片段最初来自哪里（如果它们是从其他地方复制的）。例如，假设你正在将名为 GITServerHandler.m 的文件重构为多个文件，其中一个是 GITPackUpload.m。通过使用 -C 选项对 GITPackUpload.m 进行 blame，你可以看到代码片段最初来自哪里

$ git blame -C -L 141,153 GITPackUpload.m
f344f58d GITServerHandler.m (Scott 2009-01-04 141)
f344f58d GITServerHandler.m (Scott 2009-01-04 142) - (void) gatherObjectShasFromC
f344f58d GITServerHandler.m (Scott 2009-01-04 143) {
70befddd GITServerHandler.m (Scott 2009-03-22 144)         //NSLog(@"GATHER COMMI
ad11ac80 GITPackUpload.m    (Scott 2009-03-24 145)
ad11ac80 GITPackUpload.m    (Scott 2009-03-24 146)         NSString *parentSha;
ad11ac80 GITPackUpload.m    (Scott 2009-03-24 147)         GITCommit *commit = [g
ad11ac80 GITPackUpload.m    (Scott 2009-03-24 148)
ad11ac80 GITPackUpload.m    (Scott 2009-03-24 149)         //NSLog(@"GATHER COMMI
ad11ac80 GITPackUpload.m    (Scott 2009-03-24 150)
56ef2caf GITServerHandler.m (Scott 2009-01-05 151)         if(commit) {
56ef2caf GITServerHandler.m (Scott 2009-01-05 152)                 [refDict setOb
56ef2caf GITServerHandler.m (Scott 2009-01-05 153)

这非常有用。通常情况下，你得到的原始提交是将代码复制过来的提交，因为这是你第一次在该文件中修改这些行。Git 会告诉你最初编写这些行的提交，即使它是在另一个文件中。

二分搜索

如果你知道问题在哪里，则文件注释很有帮助。如果你不知道是什么导致了问题，并且自从你上次知道代码工作时的状态以来已经进行了数十次或数百次提交，你可能会转向 git bisect 以寻求帮助。bisect 命令对你的提交历史进行二分搜索，以帮助你尽快确定哪个提交引入了问题。

假设你刚刚将代码发布到生产环境，并且收到了关于开发环境中不存在的错误报告，你无法想象代码为什么会这样。你回到你的代码，结果发现你可以重现问题，但你无法弄清楚哪里出了问题。你可以二分查找代码来找出问题所在。首先，运行git bisect start开始操作，然后使用git bisect bad告诉系统你当前所在的提交已损坏。然后，你必须使用git bisect good <good_commit>告诉二分查找上一个已知良好的状态。

$ git bisect start
$ git bisect bad
$ git bisect good v1.0
Bisecting: 6 revisions left to test after this
[ecb6e1bc347ccecc5f9350d878ce677feb13d3b2] Error handling on repo

Git 发现你标记为上一个良好提交 (v1.0) 和当前错误版本之间大约有 12 个提交，它为你检出了中间的一个提交。此时，你可以运行你的测试以查看此提交是否存在问题。如果存在，则它是在此中间提交之前某个时间引入的；如果不存在，则问题是在此中间提交之后某个时间引入的。结果发现这里没有问题，你通过输入git bisect good告诉 Git 并继续你的旅程。

$ git bisect good
Bisecting: 3 revisions left to test after this
[b047b02ea83310a70fd603dc8cd7a6cd13d15c04] Secure this thing

现在你处于另一个提交上，位于你刚刚测试的提交和你的错误提交之间。你再次运行你的测试并发现此提交已损坏，因此你使用git bisect bad告诉 Git。

$ git bisect bad
Bisecting: 1 revisions left to test after this
[f71ce38690acf49c1f3c9bea38e09d82a5ce6014] Drop exceptions table

此提交没有问题，现在 Git 拥有了确定问题引入位置所需的所有信息。它会告诉你第一个错误提交的 SHA-1，并显示一些提交信息以及该提交中修改的文件，以便你可以弄清楚可能导致此错误发生的原因。

$ git bisect good
b047b02ea83310a70fd603dc8cd7a6cd13d15c04 is first bad commit
commit b047b02ea83310a70fd603dc8cd7a6cd13d15c04
Author: PJ Hyett <[email protected]>
Date:   Tue Jan 27 14:48:32 2009 -0800

    Secure this thing

:040000 040000 40ee3e7821b895e52c1695092db9bdc4c61d1730
f24d3c6ebcfc639b1a3814550e62d60b8e68a8e4 M  config

完成后，你应该运行git bisect reset将你的 HEAD 重置到开始之前的位置，否则你将处于一个奇怪的状态。

$ git bisect reset

这是一个强大的工具，可以帮助你在几分钟内检查数百次提交以查找引入的错误。事实上，如果你有一个脚本，如果项目正常则退出 0，如果项目错误则退出非 0，那么你可以完全自动化git bisect。首先，你再次通过提供已知错误和良好提交来告诉它二分查找的范围。如果你愿意，可以通过使用bisect start命令列出它们来实现此目的，首先列出已知错误提交，然后列出已知良好提交。

$ git bisect start HEAD v1.0
$ git bisect run test-error.sh

这样做会自动在每个检出的提交上运行test-error.sh，直到 Git 找到第一个错误提交。你也可以运行类似make或make tests之类的命令，或者运行你用于运行自动化测试的任何命令。

scroll-to-top