在代码release时,我们通常需要列出或拣选此次release相关的新功能和已修复的Bug说明列表,作为版本说明文档。此时我们可以使用git log
轻松做到(当然要求commit中的提交说明符合某种已定规范 ?
例如:
# 版本迭代周期为3周(即3周一次release)
git log --pretty=format:"%s" --since=3.weeks
git --pretty
选项,可以指定使用完全不同于默认格式的方式展示提交历史。比如用oneline
将 每个提交 放在一行显示,这在提交数很大时非常有用。另外还有short
,full
和fuller
可以用,展示的信息或多或少有些不同,请自己动手实践一下看看效果如何。
$ git log --pretty=oneline
ca82a6dff817ec66f44342007202690a93763949 changed the version number
085bb3bcb608e1e8451d4b2432f8ecbe6306e7e7 removed unnecessary test code
a11bef06a3f659402fe7563abf99ad00de2209e6 first commit
但最有意思的是 format
,可以定制要显示的记录格式,这样的输出便于后期编程提取分析,像这样:
$ git log --pretty=format:"%h - %an, %ar : %s"
ca82a6d - Scott, 11 months ago : changed the version number
085bb3b - Scott, 11 months ago : removed unnecessary test code
a11bef0 - Scott, 11 months ago : first commit
下表列出了常用的格式占位符写法及其代表的意义:
选项 | 说明 |
---|---|
%H | 提交对象(commit )的完整哈希字串 |
%h | 提交对象的简短哈希字串 |
%T | 树对象(tree )的完整哈希字串 |
%t | 树对象的简短哈希字串 |
%P | 父对象(parent )的完整哈希字串 |
%p | 父对象的简短哈希字串 |
%an | 作者(author )的名字 |
%ae | 作者的电子邮件地址 |
%ad | 作者修订日期(可以用 -date= 选项定制格式) |
%ar | 作者修订日期,按多久以前的方式显示 |
%cn | 提交者(committer )的名字 |
%ce | 提交者的电子邮件地址 |
%cd | 提交日期 |
%cr | 提交日期,按多久以前的方式显示 |
%s | 提交说明 |
用 oneline
或 format
时结合 --graph
选项,可以看到开头多出一些 ASCII 字符串表示的简单图形,形象地展示了每个提交所在的分支及其分化衍合情况:
$ git log --pretty=format:"%h %s" --graph
* 2d3acf9 ignore errors from SIGCHLD on trap
* 5e3ee11 Merge branch 'master' of git://github.com/dustin/grit
|\
| * 420eac9 Added a 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
命令支持的选项。下表还列出了一些其他常用的选项及其释义:
选项 | 说明 |
---|---|
-p | 按补丁格式显示每个更新之间的差异。 |
--stat | 显示每次更新的文件修改统计信息。 |
--shortstat | 只显示 --stat 中最后的行数修改添加移除统计。 |
--name-only | 仅在提交信息后显示已修改的文件清单。 |
--name-status | 显示新增、修改、删除的文件清单。 |
--abbrev-commit | 仅显示SHA-1 的前几个字符,而非所有的 40 个字符。 |
--relative-date | 使用较短的相对时间显示(比如,“2 weeks ago ”)。 |
--graph | 显示ASCII 图形表示的分支合并历史。 |
--pretty | 使用其他格式显示历史提交信息。 可用的选项包括 oneline ,short ,full ,fuller 和format (后跟指定格式)。 |
限制输出长度
除了定制输出格式的选项之外,git log
还有许多非常实用的限制输出长度的选项,也就是只输出部分提交信息。之前我们已经看到过-2
了,它只显示最近的两条提交,实际上,这是-<n>
选项的写法,其中的n
可以是任何自然数,表示仅显示最近的若干条提交。不过实践中我们是不太用这个选项的,Git 在输出所有提交时会自动调用分页程序(less),要看更早的更新只需翻到下页即可。
另外还有按照时间作限制的选项,比如 --since
和 --until
。下面的命令列出所有最近两周内的提交:
git log --since=2.weeks
你可以给出各种时间格式,比如说具体的某一天(2008-01-15
),或者是多久以前(2 years 1 day 3 minutes ago
)。
还可以给出若干搜索条件,列出符合的提交。用 --author
选项显示指定作者的提交,用--grep
选项搜索提交说明中的关键字。(请注意,如果要得到同时满足这两个选项搜索条件的提交,就必须用--all-match
选项。)
如果只关心某些文件或者目录的历史提交,可以在 git log
选项的最后指定它们的路径。因为是放在最后位置上的选项,所以用两个短划线(--
)隔开之前的选项和后面限定的路径名。
下表还列出了其他常用的类似选项。
选项 | 说明 |
---|---|
-(n) | 仅显示最近的n 条提交 |
--since, --after | 仅显示指定时间之后的提交。 |
--until, --before | 仅显示指定时间之前的提交。 |
--author | 仅显示指定作者相关的提交。 |
--committer | 仅显示指定提交者相关的提交。 |
来看一个实际的例子,如果要查看 Git 仓库中,2010 年 10 月期间,gitster 提交的但未合并的测试脚本(位于项目的 test/
目录下的文件),可以用下面的查询命令:
git log --pretty="%h - %s" --author=gitster --since="2010-10-01" \
--before="2010-11-01" --no-merges -- test/
5610e3b - Fix testcase failure when extended attribute
acd3b9e - Enhance hold_lock_file_for_{update,append}()
f563754 - demonstrate breakage of detached checkout wi
d1a43f2 - reset --hard/read-tree --reset -u: remove un
51a94af - Fix "checkout --track -b newbranch" on detac
参考链接: Git Log查看提交历史