章節 ▾ 第二版

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。你也可以提供一個行範圍或一個單獨的行號，你將獲得相同的輸出。