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

コマンドラインから、または --stdin を介してファイルから与えられた各パス名について、そのファイルが .gitignore (または除外メカニズムへの他の入力ファイル) によって除外されているかどうかを確認し、除外されている場合はパスを出力します。

デフォルトでは、追跡されているファイルは除外ルールに従わないため、まったく表示されません。ただし、'--no-index' を参照してください。

デフォルトでは、指定されたパス名で無視パターンに一致するものが1行に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]

git[1]スイートの一部