第二版

2.3 Git基础 - 查看提交历史

查看提交历史

在创建了若干提交后，或者如果你克隆了一个带有现有提交历史的仓库，你可能会想回顾一下都发生了什么。最基本也是最强大的工具是 git log 命令。

这些示例使用一个非常简单的项目，名为“simplegit”。要获取该项目，请运行

$ git clone https://github.com/schacon/simplegit-progit

当你在该项目中运行 git log 时，你应该会看到类似以下的输出

$ git log
commit ca82a6dff817ec66f44342007202690a93763949
Author: Scott Chacon <schacon@gee-mail.com>
Date:   Mon Mar 17 21:52:11 2008 -0700

    Change version number

commit 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
Author: Scott Chacon <schacon@gee-mail.com>
Date:   Sat Mar 15 16:40:33 2008 -0700

    Remove unnecessary test

commit a11bef06a3f659402fe7563abf99ad00de2209e6
Author: Scott Chacon <schacon@gee-mail.com>
Date:   Sat Mar 15 10:31:28 2008 -0700

    Initial commit

默认情况下，不带任何参数的 git log 会以逆 chronological 顺序列出仓库中的提交；也就是说，最近的提交会先显示。正如你所看到的，这个命令列出了每个提交的 SHA-1 校验和、作者姓名和电子邮件、编写日期以及提交消息。

git log 命令提供了大量各种各样的选项，可以帮助你精确地找到你想要的信息。在这里，我们将展示一些最受欢迎的选项。

最有用的选项之一是 -p 或 --patch，它会显示每个提交引入的差异（补丁输出）。你还可以限制显示的日志条目数量，例如使用 -2 只显示最后两条条目。

$ git log -p -2
commit ca82a6dff817ec66f44342007202690a93763949
Author: Scott Chacon <schacon@gee-mail.com>
Date:   Mon Mar 17 21:52:11 2008 -0700

    Change version number

diff --git a/Rakefile b/Rakefile
index a874b73..8f94139 100644
--- a/Rakefile
+++ b/Rakefile
@@ -5,7 +5,7 @@ require 'rake/gempackagetask'
 spec = Gem::Specification.new do |s|
     s.platform  =   Gem::Platform::RUBY
     s.name      =   "simplegit"
-    s.version   =   "0.1.0"
+    s.version   =   "0.1.1"
     s.author    =   "Scott Chacon"
     s.email     =   "schacon@gee-mail.com"
     s.summary   =   "A simple gem for using Git in Ruby code."

commit 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
Author: Scott Chacon <schacon@gee-mail.com>
Date:   Sat Mar 15 16:40:33 2008 -0700

    Remove unnecessary test

diff --git a/lib/simplegit.rb b/lib/simplegit.rb
index a0a60ae..47c6340 100644
--- a/lib/simplegit.rb
+++ b/lib/simplegit.rb
@@ -18,8 +18,3 @@ class SimpleGit
     end

 end
-
-if $0 == __FILE__
-  git = SimpleGit.new
-  puts git.show
-end

这个选项会显示相同的信息，但每个条目后面都直接跟着一个 diff。这对于代码审查或快速浏览协作者添加的一系列提交发生了什么非常有帮助。你还可以使用一系列总结选项与 git log 一起使用。例如，如果你想查看每个提交的一些摘要统计信息，可以使用 --stat 选项

$ git log --stat
commit ca82a6dff817ec66f44342007202690a93763949
Author: Scott Chacon <schacon@gee-mail.com>
Date:   Mon Mar 17 21:52:11 2008 -0700

    Change version number

 Rakefile | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

commit 085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7
Author: Scott Chacon <schacon@gee-mail.com>
Date:   Sat Mar 15 16:40:33 2008 -0700

    Remove unnecessary test

 lib/simplegit.rb | 5 -----
 1 file changed, 5 deletions(-)

commit a11bef06a3f659402fe7563abf99ad00de2209e6
Author: Scott Chacon <schacon@gee-mail.com>
Date:   Sat Mar 15 10:31:28 2008 -0700

    Initial commit

 README           |  6 ++++++
 Rakefile         | 23 +++++++++++++++++++++++
 lib/simplegit.rb | 25 +++++++++++++++++++++++++
 3 files changed, 54 insertions(+)

正如你所看到的，--stat 选项会在每个提交条目下方打印一个修改过的文件列表，显示有多少文件被更改，以及在这些文件中添加和删除了多少行。它还在最后放置了信息的摘要。

另一个非常实用的选项是 --pretty。这个选项会将日志输出更改为默认以外的其他格式。为你提供了一些预设的选项值。该选项的 oneline 值会将每个提交打印在单行上，这对于查看大量提交很有用。此外，short、full 和 fuller 值分别以大致相同的格式显示输出，但包含的信息量更少或更多。

$ git log --pretty=oneline
ca82a6dff817ec66f44342007202690a93763949 Change version number
085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7 Remove unnecessary test
a11bef06a3f659402fe7563abf99ad00de2209e6 Initial commit

最有趣的选项值是 format，它允许你指定自己的日志输出格式。这在生成供机器解析的输出时特别有用——因为你明确指定了格式，所以你知道它不会随着 Git 的更新而改变。

$ git log --pretty=format:"%h - %an, %ar : %s"
ca82a6d - Scott Chacon, 6 years ago : Change version number
085bb3b - Scott Chacon, 6 years ago : Remove unnecessary test
a11bef0 - Scott Chacon, 6 years ago : Initial commit

git log --pretty=format 的有用说明符列出了一些 format 可以接受的更实用的说明符。

表 1. `git log --pretty=format` 的有用说明符
说明符	输出说明
`%H`	提交哈希
`%h`	缩写的提交哈希
`%T`	树哈希
`%t`	缩写的树哈希
`%P`	父提交哈希
`%p`	缩写的父提交哈希
`%an`	作者姓名
`%ae`	作者电子邮件
`%ad`	作者日期（格式遵守 `--date=option`）
`%ar`	作者日期，相对
`%cn`	提交者姓名
`%ce`	提交者电子邮件
`%cd`	提交者日期
`%cr`	提交者日期，相对
`%s`	主题

你可能想知道 *作者* 和 *提交者* 之间的区别。作者是最初创作作品的人，而提交者是最后应用该作品的人。所以，如果你向一个项目发送一个补丁，而核心成员之一应用了该补丁，你们俩都会获得认可——你作为作者，核心成员作为提交者。我们将在分布式 Git 中更详细地介绍这种区别。

oneline 和 format 选项值与另一个名为 --graph 的 log 选项特别有用。这个选项会添加一个漂亮的 ASCII 图，显示你的分支和合并历史。

$ git log --pretty=format:"%h %s" --graph
* 2d3acf9 Ignore errors from SIGCHLD on trap
*  5e3ee11 Merge branch 'master' of https://github.com/dustin/grit.git
|\
| * 420eac9 Add method for getting the current branch
* | 30e367c Timeout code and tests
* | 5a09431 Add timeout protection to grit
* | e1193f8 Support for heads with slashes in them
|/
* d6016bc Require time for xmlschema
*  11d191e Merge branch 'defunkt' into local

这种类型的输出在我们将在下一章中进行的分支和合并时会变得更有趣。

这些只是 git log 的一些简单的输出格式化选项——还有很多。 git log 的常用选项列出了我们到目前为止介绍的选项，以及一些其他可能有用的常见格式化选项，以及它们如何改变 log 命令的输出。

表 2. `git log` 的常用选项
选项	说明
`-p`	显示每个提交引入的补丁。
`--stat`	显示每个提交中修改过的文件的统计信息。
`--shortstat`	仅显示 `--stat` 命令的已更改/插入/删除行。
`--name-only`	在提交信息后显示修改过的文件列表。
`--name-status`	显示受影响的文件列表，并附带添加/修改/删除信息。
`--abbrev-commit`	只显示 SHA-1 校验和的前几个字符，而不是全部 40 个。
`--relative-date`	以相对格式（例如，“2 周前”）显示日期，而不是使用完整日期格式。
`--graph`	在日志输出旁边显示分支和合并历史的 ASCII 图。
`--pretty`	以其他格式显示提交。选项值包括 `oneline`、`short`、`full`、`fuller` 和 `format`（你可以在其中指定自己的格式）。
`--oneline`	`--pretty=oneline --abbrev-commit` 一起使用的简写。

限制日志输出

除了输出格式化选项外，git log 还接受许多有用的限制选项；也就是说，允许你只显示部分提交的选项。你已经看到过一个这样的选项——-2 选项，它只显示最后两个提交。事实上，你可以使用 -<n>，其中 n 是任何整数，来显示最后 n 个提交。实际上，你不太可能经常使用它，因为 Git 默认通过分页器管道传输所有输出，所以你一次只能看到一页日志输出。

然而，像 --since 和 --until 这样的时间限制选项非常有用。例如，这个命令会获取过去两周内进行的提交列表

$ git log --since=2.weeks

这个命令可以处理很多格式——你可以指定一个具体日期，如 "2008-01-15"，或者一个相对日期，如 "2 years 1 day 3 minutes ago"。

你还可以过滤列表以查找匹配某些搜索条件的提交。 --author 选项允许你按特定作者进行过滤，而 --grep 选项则允许你在提交消息中搜索关键字。

注意	你可以指定多个 `--author` 和 `--grep` 搜索条件实例，这将把提交输出限制为匹配任何 `--author` 模式和任何 `--grep` 模式的提交；然而，添加 `--all-match` 选项会进一步将输出限制为仅匹配所有 `--grep` 模式的提交。

另一个非常有用的过滤器是 -S 选项（俗称 Git 的“pickaxe”选项），它接受一个字符串，只显示那些改变了该字符串出现次数的提交。例如，如果你想找到最后一次添加或删除对特定函数的引用的提交，你可以调用

$ git log -S function_name

传递给 git log 作为过滤器的最后一个有用的选项是路径。如果你指定一个目录或文件名，你可以将日志输出限制为引入了对这些文件更改的提交。这始终是最后一个选项，并且通常前面带有双破折号（--）来将路径与选项分开。

$ git log -- path/to/file

在限制 git log 输出的选项中，我们将列出这些以及其他一些常见的选项供你参考。

表 3. 限制 `git log` 输出的选项
选项	说明
`-<n>`	只显示最后 n 个提交。
`--since`, `--after`	将提交限制在指定日期之后进行的提交。
`--until`, `--before`	将提交限制在指定日期之前进行的提交。
`--author`	只显示作者条目匹配指定字符串的提交。
`--committer`	只显示提交者条目匹配指定字符串的提交。
`--grep`	只显示提交消息包含指定字符串的提交。
`-S`	只显示添加或删除与指定字符串匹配的代码的提交。

例如，如果你想查看 Git 源代码历史中修改了测试文件的提交，这些提交由 Junio Hamano 在 2008 年 10 月提交，并且不是合并提交，你可以运行如下命令：

$ git log --pretty="%h - %s" --author='Junio C Hamano' --since="2008-10-01" \
   --before="2008-11-01" --no-merges -- t/
5610e3b - Fix testcase failure when extended attributes are in use
acd3b9e - Enhance hold_lock_file_for_{update,append}() API
f563754 - demonstrate breakage of detached checkout with symbolic link HEAD
d1a43f2 - reset --hard/read-tree --reset -u: remove unmerged new paths
51a94af - Fix "checkout --track -b newbranch" on detached HEAD
b0ad11e - pull: allow "git pull origin $something:$current_branch" into an unborn branch

在 Git 源代码历史近 40,000 次提交中，这个命令显示了 6 次符合这些条件的提交。

提示	阻止显示合并提交取决于你仓库中使用的工作流程，你的日志历史中可能相当一部分提交只是合并提交，而这些提交通常信息量不大。为了防止合并提交充斥你的日志历史，只需添加 `log` 选项 `--no-merges`。

上一步 | 下一步

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 命令

2.3 Git基础 - 查看提交历史

查看提交历史

限制日志输出