git-check-ignore - gitignore / 除外ファイルのデバッグ

コマンドラインまたは --stdin を介して与えられた各パス名について、そのファイルが .gitignore（または除外機構の他の入力ファイル）により除外されているかをチェックし、除外されていればそのパスを出力します。

デフォルトでは、追跡中のファイルは除外ルールの対象にならないため、一切表示されません。ただし、--no-index を参照してください。

デフォルトでは、指定されたパス名が ignore パターンに一致すると、そのパスが1行ずつ出力されます。もしどのパターンにも一致しなければ、そのパスについては何も出力されません。つまり、そのパスは無視されないことを意味します。

もし --verbose が指定されると、出力は次の形式の一連の行となります:

<source> <COLON> <linenum> <COLON> <pattern> <HT> <pathname>

<pathname> は照会されるファイルのパス、<pattern> は一致したパターン、<source> はパターンのソースファイル、そして <linenum> はそのソース内でのパターンの行番号です。パターンに "!" のプレフィックスまたは "/" のサフィックスが含まれている場合、出力時にそのまま保持されます。<source> は、core.excludesFile で設定されたファイルを指す場合は絶対パスになり、.git/info/exclude または各ディレクトリの除外ファイルを指す場合はリポジトリルートからの相対パスとなります。

もし -z が指定されると、出力されるパス名はヌル文字で区切られます。また、--verbose が指定された場合、コロンやハードタブの代わりにヌル文字が使用されます:

<source> <NULL> <linenum> <NULL> <pattern> <NULL> <pathname> <NULL>

もし -n または --non-matching が指定されると、非一致のパス名も出力され、その場合、各出力レコードにおいて <pathname> を除くすべてのフィールドが空になります。これは、対話的でない実行時に、ファイルを長時間動作する check-ignore プロセスの STDIN に順次送信でき、各ファイルごとに STDOUT がそのファイルがパターンに一致したか否かを示すために有用です。（このオプションなしでは、あるファイルについて出力がない場合に、そのファイルがパターンに一致しなかったのか、あるいはまだ出力が生成されていないのかを判断することは不可能になります。）

バッファリングは git[1] の GIT_FLUSH オプションに記載されている通りに行われます。呼び出し側は、入力バッファの過剰な充填や出力バッファの空読みから生じるデッドロックを回避する責任があります。

gitignore[5] git-config[1] git-ls-files[1]

Part of the git[1] suite