章節 ▾ 第二版

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”任一子字串的任何行，特別是在由標籤 v1.8.0 表示的 Git 程式碼庫的舊版本中（我們將加入有助於將輸出分成更易讀格式的 --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 日誌搜尋

也許你查詢的不是一個術語存在的位置，而是它何時存在或被引入的。git log 命令有許多強大的工具，可以透過提交訊息的內容甚至它們引入的差異內容來查詢特定的提交。

例如，如果我們想找出 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

如果我們檢視這些提交的差異，可以看到在 ef49a7a 中引入了該常量，並在 e01503b 中對其進行了修改。

如果你需要更具體，可以使用 -G 選項提供一個正則表示式進行搜尋。

行日誌搜尋

另一個非常高階且極其有用的日誌搜尋是行歷史搜尋。只需執行帶 -L 選項的 git log 命令，它將顯示你程式碼庫中某個函式或程式碼行的歷史記錄。

例如，如果我們想檢視 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。你也可以給它一個行範圍或單個行號，你將獲得相同型別的輸出。

scroll-to-top