Git
English ▾ トピック ▾ 最新バージョン ▾ git-check-ignore の最終更新は 2.43.0

名前

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

概要

git check-ignore [<options>] <pathname>…​
git check-ignore [<options>] --stdin

説明

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

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

オプション

-q, --quiet

何も出力せず、終了ステータスのみを設定します。これは、単一のパス名でのみ有効です。

-v, --verbose

除外されたパスを出力する代わりに、除外パターンに一致する各パスについて、パスとともに除外パターンを出力します。(除外パターンに一致することは通常、パスが除外されることを意味しますが、パターンが "!" で始まる場合は否定パターンであり、それに一致することはパスが除外されないことを意味します。)

除外ソース内およびソース間の優先順位ルールについては、gitignore[5]を参照してください。

--stdin

コマンドラインからではなく、標準入力から 1 行に 1 つずつパス名を読み取ります。

-z

出力形式が機械で解析可能なように変更されます(下記を参照)。 --stdin も指定されている場合、入力パスは改行文字ではなく NUL 文字で区切られます。

-n, --non-matching

パターンに一致しない指定されたパスを表示します。これは --verbose が有効になっている場合にのみ意味があります。そうでない場合は、パターンに一致するパスと一致しないパスを区別することができません。

--no-index

チェックを実行するときにインデックスを調べないでください。これは、たとえば git add . でパスが追跡され、ユーザーが予期したようにルールで無視されなかった理由をデバッグしたり、git add -f で以前に追加されたパスに一致させるための否定を含むパターンを開発したりする場合に使用できます。

出力

デフォルトでは、無視パターンに一致する指定されたパス名はすべて、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 オプションで文書化されているように行われます。呼び出し元は、入力バッファの過剰な書き込みや空の出力バッファからの読み取りによって発生するデッドロックを回避する責任があります。

終了ステータス

0

提供されたパスの 1 つ以上が無視されます。

1

提供されたパスはどれも無視されません。

128

致命的なエラーが発生しました。

GIT

git[1] スイートの一部

scroll-to-top