章节 ▾ 第二版

7.5 Git 工具 - 搜索

搜索

在几乎任何规模的代码库中，你经常需要找到函数被调用或定义的位置，或者显示某个方法的历史记录。Git 提供了几个有用的工具，可以快速轻松地浏览其数据库中存储的代码和提交。我们将介绍其中一些。

Git Grep

Git 提供了一个名为 grep 的命令，允许你轻松地在任何已提交的树、工作目录甚至索引中搜索字符串或正则表达式。在接下来的示例中，我们将搜索 Git 本身（的源代码）。

默认情况下，git grep 会搜索你工作目录中的文件。作为第一个变体，你可以使用 -n 或 --line-number 选项来打印 Git 找到匹配项的行号。

$ git grep -n gmtime_r
compat/gmtime.c:3:#undef gmtime_r
compat/gmtime.c:8:      return git_gmtime_r(timep, &result);
compat/gmtime.c:11:struct tm *git_gmtime_r(const time_t *timep, struct tm *result)
compat/gmtime.c:16:     ret = gmtime_r(timep, result);
compat/mingw.c:826:struct tm *gmtime_r(const time_t *timep, struct tm *result)
compat/mingw.h:206:struct tm *gmtime_r(const time_t *timep, struct tm *result);
date.c:482:             if (gmtime_r(&now, &now_tm))
date.c:545:             if (gmtime_r(&time, tm)) {
date.c:758:             /* gmtime_r() in match_digit() may have clobbered it */
git-compat-util.h:1138:struct tm *git_gmtime_r(const time_t *, struct tm *);
git-compat-util.h:1140:#define gmtime_r git_gmtime_r

除了上面展示的基本搜索之外，git grep 还支持大量其他有趣的选项。

例如，你不需要打印所有匹配项，而是可以要求 git grep 总结输出，只显示包含搜索字符串的文件以及每个文件中匹配项的数量，使用 -c 或 --count 选项。

$ git grep --count gmtime_r
compat/gmtime.c:4
compat/mingw.c:1
compat/mingw.h:1
date.c:3
git-compat-util.h:2

如果你对搜索字符串的上下文感兴趣，可以使用 -p 或 --show-function 选项来显示每个匹配字符串的包含它的方法或函数的定义。

$ git grep -p gmtime_r *.c
date.c=static int match_multi_number(timestamp_t num, char c, const char *date,
date.c:         if (gmtime_r(&now, &now_tm))
date.c=static int match_digit(const char *date, struct tm *tm, int *offset, int *tm_gmt)
date.c:         if (gmtime_r(&time, tm)) {
date.c=int parse_date_basic(const char *date, timestamp_t *timestamp, int *offset)
date.c:         /* gmtime_r() in match_digit() may have clobbered it */

正如你所见，gmtime_r 例程在 date.c 文件中的 match_multi_number 和 match_digit 函数中被调用（显示的第三个匹配项仅代表字符串出现在注释中）。

你还可以使用 --and 标志搜索字符串的复杂组合，这确保了多个匹配项必须出现在同一行文本中。例如，让我们查找任何定义了一个常量，其名称包含“LINK”或“BUF_MAX”这两个子字符串中的任一个的行，特别是在 Git 代码库的旧版本（由标签 v1.8.0 表示）中（我们还将添加 --break 和 --heading 选项，它们有助于将输出分成更易读的格式）。

$ git grep --break --heading \
    -n -e '#define' --and \( -e LINK -e BUF_MAX \) v1.8.0
v1.8.0:builtin/index-pack.c
62:#define FLAG_LINK (1u<<20)

v1.8.0:cache.h
73:#define S_IFGITLINK  0160000
74:#define S_ISGITLINK(m)       (((m) & S_IFMT) == S_IFGITLINK)

v1.8.0:environment.c
54:#define OBJECT_CREATION_MODE OBJECT_CREATION_USES_HARDLINKS

v1.8.0:strbuf.c
326:#define STRBUF_MAXLINK (2*PATH_MAX)

v1.8.0:symlinks.c
53:#define FL_SYMLINK  (1 << 2)

v1.8.0:zlib.c
30:/* #define ZLIB_BUF_MAX ((uInt)-1) */
31:#define ZLIB_BUF_MAX ((uInt) 1024 * 1024 * 1024) /* 1GB */

git grep 命令比普通的搜索命令（如 grep 和 ack）有几个优点。第一个是它非常快，第二个是你可以在 Git 的任何树中搜索，而不仅仅是工作目录。正如我们在上面的例子中看到的，我们搜索的是 Git 源代码的一个旧版本中的术语，而不是当前检出的版本。

Git Log 搜索

也许你正在寻找的不是术语存在的位置，而是它何时存在或被引入。git log 命令提供了许多强大的工具，可以通过提交消息的内容甚至引入的 diff 的内容来查找特定的提交。

例如，如果我们想找出 ZLIB_BUF_MAX 常量最初是什么时候引入的，我们可以使用 -S 选项（俗称 Git “拾取器”选项），告诉 Git 只显示那些改变了该字符串出现次数的提交。

$ git log -S ZLIB_BUF_MAX --oneline
e01503b zlib: allow feeding more than 4GB in one go
ef49a7a zlib: zlib can only process 4GB at a time

如果我们查看这些提交的 diff，我们可以看到在 ef49a7a 中引入了该常量，而在 e01503b 中对其进行了修改。

如果你需要更具体，可以使用 -G 选项提供一个正则表达式进行搜索。

行日志搜索

另一个相当高级但非常有用的日志搜索是行历史搜索。只需运行 git log 并带上 -L 选项，它就会显示代码库中函数或代码行的历史记录。

例如，如果我们想查看在 zlib.c 文件中对 git_deflate_bound 函数的所有更改，我们可以运行 git log -L :git_deflate_bound:zlib.c。这将尝试确定该函数的边界，然后查找历史记录，并将函数中发生的所有更改作为一系列补丁显示出来，直到函数首次创建为止。

$ git log -L :git_deflate_bound:zlib.c
commit ef49a7a0126d64359c974b4b3b71d7ad42ee3bca
Author: Junio C Hamano <gitster@pobox.com>
Date:   Fri Jun 10 11:52:15 2011 -0700

    zlib: zlib can only process 4GB at a time

diff --git a/zlib.c b/zlib.c
--- a/zlib.c
+++ b/zlib.c
@@ -85,5 +130,5 @@
-unsigned long git_deflate_bound(z_streamp strm, unsigned long size)
+unsigned long git_deflate_bound(git_zstream *strm, unsigned long size)
 {
-       return deflateBound(strm, size);
+       return deflateBound(&strm->z, size);
 }


commit 225a6f1068f71723a910e8565db4e252b3ca21fa
Author: Junio C Hamano <gitster@pobox.com>
Date:   Fri Jun 10 11:18:17 2011 -0700

    zlib: wrap deflateBound() too

diff --git a/zlib.c b/zlib.c
--- a/zlib.c
+++ b/zlib.c
@@ -81,0 +85,5 @@
+unsigned long git_deflate_bound(z_streamp strm, unsigned long size)
+{
+       return deflateBound(strm, size);
+}
+

如果 Git 无法确定如何匹配你的编程语言中的函数或方法，你也可以提供一个正则表达式（或regex）。例如，以下命令将执行与上面示例相同的操作：git log -L '/unsigned long git_deflate_bound/',/^}/:zlib.c。你也可以提供一个行范围或一个单独的行号，你将获得相同的输出。