Git
目次 ▾ 第2版

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は他にも多くの便利なオプションをサポートしています。

例えば、すべてのマッチを印刷する代わりに、-cまたは--countオプションを使用して、検索文字列が含まれるファイルと、各ファイル内の一致数を表示することで出力を要約するようにgit grepに指示できます。

$ 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関数の両方から呼び出されています（3番目に表示される一致は、コメント内に表示されている文字列を表しています）。

--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などの通常の検索コマンドよりもいくつかの利点があります。1つ目は非常に高速であること、2つ目は作業ディレクトリだけでなく、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

これらのコミットの差分を見ると、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を実行します。行範囲または単一行番号を指定しても、同様の出力が得られます。

scroll-to-top