コマンドとオプション

問題を報告 ソースを表示

このページでは、bazel buildbazel runbazel test などのさまざまな Bazel コマンドで使用できるオプションについて説明します。このページは、Build with Bazel に記載されている Bazel のコマンドの一覧に対応するものです。

ターゲットの構文

buildtest などの一部のコマンドは、ターゲットのリストに対して操作できます。ラベルよりも柔軟な構文を使用します。詳細については、ビルドするターゲットの指定をご覧ください。

オプション

以降のセクションでは、ビルド中に使用できるオプションについて説明します。ヘルプコマンドで --long を使用すると、オンライン ヘルプ メッセージに各オプションの意味、タイプ、デフォルト値に関する概要情報が表示されます。

ほとんどのオプションは 1 回しか指定できません。複数回指定した場合は、最後のインスタンスが優先されます。複数回指定できるオプションは、オンライン ヘルプの「複数回使用できる」というテキストで示されています。

パッケージの場所

--package_path

このオプションは、特定のパッケージの BUILD ファイルを見つけるために検索される一連のディレクトリを指定します。

Bazel は、パッケージのパスを検索してパッケージを見つけます。これは、bazel ディレクトリをコロンで区切った順序付きリストで、それぞれが部分ソースツリーのルートです。

--package_path オプションを使用してカスタム パッケージ パスを指定するには:

  % bazel build --package_path %workspace%:/some/other/root

パッケージパス要素は、次の 3 つの形式で指定できます。

  1. 最初の文字が / の場合、パスは絶対パスです。
  2. パスが %workspace% で始まる場合、パスは、最も近い bazel ディレクトリからの相対パスになります。たとえば、作業ディレクトリが /home/bob/clients/bob_client/bazel/foo の場合、package-path の文字列 %workspace%/home/bob/clients/bob_client/bazel に展開されます。
  3. それ以外はすべて、作業ディレクトリを基準とする相対パスになります。通常、これは意図したものではありません。また、bazel ワークスペースのディレクトリから Bazel を使用すると、予期しない動作が発生する可能性があります。たとえば、package-path 要素 . を使用してから cd でディレクトリ /home/bob/clients/bob_client/bazel/foo に移動すると、パッケージは /home/bob/clients/bob_client/bazel/foo ディレクトリから解決されます。

デフォルト以外のパッケージパスを使用する場合は、便宜上 Bazel 構成ファイルで指定します。

Bazel では、パッケージを現在のディレクトリに配置する必要はありません。したがって、必要なすべてのパッケージがパッケージ パスの別の場所で見つかれば、空の bazel ワークスペースからビルドできます。

例: 空のクライアントからのビルド

  % mkdir -p foo/bazel
  % cd foo/bazel
  % touch WORKSPACE
  % bazel build --package_path /some/other/path //foo

--deleted_packages

このオプションは、Bazel が削除済みと見なし、パッケージパス上のディレクトリからの読み込みを試行しないパッケージのカンマ区切りのリストを指定します。これを使用すると、パッケージを実際に削除せずに、削除をシミュレートできます。このオプションは複数回渡すことができます。その場合、個々のリストは連結されます。

確認エラー

Bazel のエラーチェックや警告は、以下のオプションで制御します。

--[no]check_visibility

このオプションを false に設定すると、可視性チェックは警告に降格されます。 このオプションのデフォルト値は true であるため、デフォルトで公開設定のチェックが行われます。

--output_filter=regex

--output_filter オプションは、正規表現に一致するターゲットについてのみ、ビルドとコンパイルの警告を表示します。ターゲットが指定された正規表現と一致せず、実行が成功した場合、その標準出力と標準エラーは破棄されます。

このオプションの一般的な値は次のとおりです。

`--output_filter='^//(first/project|second/project):'` 指定したパッケージの出力を表示します。
`--output_filter='^//((?!(first/bad_project|second/bad_project):).)*$'` 指定したパッケージの出力を表示しません。
`--output_filter=` すべてを表示します。
`--output_filter=DONT_MATCH_ANYTHING` 何も表示しません。

ツールフラグ

これらのオプションは、Bazel が他のツールに渡すオプションを制御します。

--copt=cc-option

このオプションは、コンパイラに渡す引数を取ります。 この引数は、C、C++、アセンブラ コードの前処理、コンパイル、アセンブルのために呼び出されるたびにコンパイラに渡されます。リンク時に渡されません。

このオプションは複数回使用できます。次に例を示します。

  % bazel build --copt="-g0" --copt="-fpic" //foo

このコードは、デバッグ テーブルなしで foo ライブラリをコンパイルし、位置に依存しないコードを生成します。

--host_copt=cc-option

このオプションは、実行構成でコンパイルされるソースファイルについてコンパイラに渡される引数を取ります。これは --copt オプションに似ていますが、exec 構成にのみ適用されます。

--host_conlyopt=cc-option

このオプションは、実行構成でコンパイルされる C ソースファイルについてコンパイラに渡される引数を取ります。これは --conlyopt オプションに似ていますが、exec 構成にのみ適用されます。

--host_cxxopt=cc-option

このオプションは、実行構成でコンパイルされる C++ ソースファイルのためにコンパイラに渡される引数を取ります。これは --cxxopt オプションに似ていますが、exec 構成にのみ適用されます。

--host_linkopt=linker-option

このオプションは、exec 構成にコンパイルされるソースファイルのリンカーに渡される引数を取ります。これは --linkopt オプションに似ていますが、exec 構成にのみ適用されます。

--conlyopt=cc-option

このオプションは、C ソースファイルのコンパイル時にコンパイラに渡される引数を取ります。

これは --copt に似ていますが、C コンパイルにのみ適用され、C++ コンパイルまたはリンクには適用されません。そのため、--conlyopt を使用して C 固有のオプション(-Wno-pointer-sign など)を渡すことができます。

--cxxopt=cc-option

このオプションは、C++ ソースファイルのコンパイル時にコンパイラに渡される引数を取ります。

これは --copt に似ていますが、C++ コンパイルにのみ適用され、C コンパイルまたはリンクには適用されません。そのため、--cxxopt を使用して C++ 固有のオプション(-fpermissive-fno-implicit-templates など)を渡すことができます。

次に例を示します。

  % bazel build --cxxopt="-fpermissive" --cxxopt="-Wno-error" //foo/cruddy_code

--linkopt=linker-option

このオプションは、リンク時にコンパイラに渡される引数を取ります。

これは --copt と似ていますが、リンクにのみ適用され、コンパイルには適用されません。そのため、--linkopt を使用して、リンク時にのみ意味のあるコンパイラ オプション(-lssp-Wl,--wrap,abort など)を渡すことができます。次に例を示します。

  % bazel build --copt="-fmudflap" --linkopt="-lmudflap" //foo/buggy_code

ビルドルールでは、属性にリンク オプションを指定することもできます。このオプションの設定は常に優先されます。cc_library.linkopts もご覧ください。

--strip (always|never|sometimes)

このオプションは、-Wl,--strip-debug オプション付きでリンカーを呼び出すことによって、Bazel がすべてのバイナリと共有ライブラリからデバッグ情報を削除するかどうかを決定します。--strip=always は、常にデバッグ情報を削除することを意味します。--strip=never は、デバッグ情報を削除しないことを意味します。--strip=sometimes のデフォルト値では、--compilation_modefastbuild の場合は削除されます。

  % bazel build --strip=always //foo:bar

ターゲットをコンパイルし、生成されたすべてのバイナリからデバッグ情報を削除します。

Bazel の --strip オプションは ld の --strip-debug オプションに対応し、デバッグ情報のみを削除します。なんらかの理由でデバッグ シンボルだけでなく、すべてのシンボルを削除する必要がある場合は、ld の --strip-all オプションを使用する必要があります。--linkopt=-Wl,--strip-all を Bazel に渡すことで実行できます。また、Bazel の --strip フラグを設定すると --linkopt=-Wl,--strip-all がオーバーライドされるため、どちらか一方のみを設定してください。

ビルドするバイナリが 1 つだけで、すべてのシンボルを除去したい場合は、--stripopt=--strip-all を渡してターゲットの //foo:bar.stripped バージョンを明示的にビルドすることもできます。--stripopt のセクションで説明したように、ビルドのすべてのリンク アクションに削除を含めるのではなく、最終的なバイナリがリンクされた後に削除アクションを適用します。

--stripopt=strip-option

これは、*.stripped バイナリを生成するときに strip コマンドに渡す追加のオプションです。デフォルトは -S -p です。このオプションは複数回使用できます。

--fdo_instrument=profile-output-dir

--fdo_instrument オプションを使用すると、ビルドされた C/C++ バイナリの実行時に、FDO(フィードバック指向最適化)プロファイル出力を生成できます。GCC の場合、指定された引数は、各 .o ファイルのプロファイル情報を含む .gcda ファイルのオブジェクトごとのファイル ディレクトリ ツリーのディレクトリ接頭辞として使用されます。

プロファイル データツリーが生成されたら、プロファイル ツリーを圧縮して --fdo_optimize=profile-zip Bazel オプションに提供し、FDO による最適化コンパイルを有効にします。

LLVM コンパイラの場合、引数は未加工の LLVM プロファイル データファイルがダンプされるディレクトリでもあります。例: --fdo_instrument=/path/to/rawprof/dir/

--fdo_instrument オプションと --fdo_optimize オプションを同時に使用することはできません。

--fdo_optimize=profile-zip

--fdo_optimize オプションを使用すると、コンパイル時にオブジェクトごとのファイル プロファイル情報を使用して、FDO(フィードバック指向最適化)の最適化を実行できます。GCC の場合、指定される引数は、各 .o ファイルのプロファイル情報を含む .gcda ファイルの以前に生成されたファイルツリーを含む zip ファイルです。

引数として、拡張子 .afdo で識別される自動プロファイルを指定することもできます。

LLVM コンパイラの場合、提供される引数は、llvm-profdata ツールによって準備されたインデックス付き LLVM プロファイル出力ファイルを指し、.profdata 拡張子を持つ必要があります。

--fdo_instrument オプションと --fdo_optimize オプションを同時に使用することはできません。

--java_language_version=version

このオプションは、Java ソースのバージョンを指定します。次に例を示します。

  % bazel build --java_language_version=8 java/com/example/common/foo:all

Java 8 仕様と互換性のあるコンストラクトのみを許可します。デフォルト値は 8 です。--> 有効な値: 8、9、10、11、14、15、21。default_java_toolchain を使用してカスタム Java ツールチェーンを登録することで拡張できます。

--tool_java_language_version=version

ビルドで実行されるツールのビルドに使用される Java 言語バージョン。デフォルト値は 8 です。

--java_runtime_version=version

このオプションでは、コードの実行とテストの実行に使用する JVM のバージョンを指定します。次に例を示します。

  % bazel run --java_runtime_version=remotejdk_11 java/com/example/common/foo:java_application

リモート リポジトリから JDK 11 をダウンロードし、それを使用して Java アプリケーションを実行します。

デフォルト値は local_jdk です。有効な値は local_jdklocal_jdk_versionremotejdk_11remotejdk_17 です。local_java_repository または remote_java_repository リポジトリ ルールを使用してカスタム JVM を登録することで、値を拡張できます。

--tool_java_runtime_version=version

ビルド中に必要となるツールの実行に使用される JVM のバージョン。デフォルト値は remotejdk_11 です。

--jvmopt=jvm-option

このオプションを使用すると、オプション引数を Java VM に渡すことができます。1 つの大きな引数と一緒に使用することも、個々の引数と複数回使用することもできます。次に例を示します。

  % bazel build --jvmopt="-server -Xms256m" java/com/example/common/foo:all

すべての Java バイナリの起動にサーバー VM を使用し、VM の起動ヒープサイズを 256 MB に設定します。

--javacopt=javac-option

このオプションを使用すると、オプションの引数を javac に渡すことができます。1 つの大きな引数と一緒に使用することも、個々の引数と複数回使用することもできます。次に例を示します。

  % bazel build --javacopt="-g:source,lines" //myprojects:prog

(bazel のデフォルトではなく)javac のデフォルトのデバッグ情報で java_binary が再ビルドされます。

このオプションは、javac の Bazel 組み込みデフォルト オプションの後、ルールごとのオプションの前に javac に渡されます。javac のオプションの最後の指定が優先されます。javac のデフォルト オプションは次のとおりです。

  -source 8 -target 8 -encoding UTF-8

--strict_java_deps (default|strict|off|warn|error)

このオプションは、javac が直接的な依存関係の欠落を確認するかどうかを制御します。Java ターゲットは、直接使用されるすべてのターゲットを依存関係として明示的に宣言する必要があります。このフラグは、各 java ファイルの型チェックに実際に使用される jar を判別するように javac に指示します。現在のターゲットの直接的な依存関係の出力でない場合は、警告/エラーを表示します。

  • off はチェックが無効になっていることを意味します。
  • warn は、直接依存関係が欠落している場合に、javac が [strict] 型の標準 Java 警告を生成することを意味します。
  • defaultstricterror はいずれも、javac が警告ではなくエラーを生成することを意味します。そのため、欠落している直接的な依存関係が見つかった場合は、現在のターゲットのビルドが失敗します。これは、フラグが指定されていない場合のデフォルトの動作でもあります。

ビルド セマンティクス

これらのオプションは、ビルドコマンドや出力ファイルの内容に影響します。

--compilation_mode (fastbuild|opt|dbg)(-c)

--compilation_mode オプション(多くの場合、-c、特に -c opt と短縮されます)は、fastbuilddbgopt のいずれかの引数を取り、最適化レベルやデバッグ テーブルの完全性など、さまざまな C/C++ コード生成オプションに影響します。Bazel はコンパイル モードごとに異なる出力ディレクトリを使用するため、毎回完全な再ビルドを行うことなくモードを切り替えることができます。

  • fastbuild は、できる限り迅速にビルドすることを意味します。最小限のデバッグ情報(-gmlt -Wl,-S)を生成し、最適化しません。これがデフォルトです。注: -DNDEBUG は設定されません
  • dbg は、デバッグを有効にしてビルドする(-g)ことを意味します。したがって、gdb(または別のデバッガ)を使用できます。
  • opt は、最適化を有効にして assert() 呼び出しを無効にしたビルド(-O2 -DNDEBUG)を意味します。--copt -g も渡さない限り、opt モードではデバッグ情報は生成されません。

--cpu=cpu

このオプションでは、ビルド中にバイナリのコンパイルに使用するターゲット CPU アーキテクチャを指定します。

--action_env=VAR=VALUE

すべてのアクションの実行中に使用可能な環境変数のセットを指定します。変数は、名前で指定できます。名前の場合、値は呼び出し環境から取得されます。あるいは、呼び出し環境とは無関係に値を設定する name=value ペアで指定できます。

この --action_env フラグは複数回指定できます。複数の --action_env フラグで同じ変数に値が割り当てられている場合は、最新の割り当てが適用されます。

--experimental_action_listener=label

experimental_action_listener オプションは、label で指定された action_listener ルールの詳細を使用して extra_actions をビルドグラフに挿入するように Bazel に指示します。

--[no]experimental_extra_action_top_level_only

このオプションを true に設定すると、 --experimental_action_listener コマンドライン オプションで指定された追加のアクションは、最上位のターゲットに対してのみスケジュールされます。

--experimental_extra_action_filter=regex

experimental_extra_action_filter オプションは、extra_actions をスケジュールするターゲットのセットをフィルタリングするように Bazel に指示します。

このフラグは、--experimental_action_listener フラグと組み合わせた場合にのみ適用されます。

デフォルトでは、ビルド対象ターゲットの推移的クロージャ内のすべての extra_actions の実行がスケジュールされます。--experimental_extra_action_filter は、オーナーのラベルが指定された正規表現に一致する extra_actions にスケジューリングを制限します。

次の例では、オーナーのラベルに「/bar/」が含まれているアクションにのみ適用するように、extra_actions のスケジュール設定を制限します。

% bazel build --experimental_action_listener=//test:al //foo/... \
  --experimental_extra_action_filter=.*/bar/.*

--host_cpu=cpu

このオプションでは、ホストツールのビルドに使用する CPU アーキテクチャの名前を指定します。

--android_platforms=platform[,platform]*

android_binary ルールの推移的 deps をビルドするプラットフォーム(特に C++ などのネイティブ依存関係用)。たとえば、android_binary ルールの推移的 depscc_library が含まれる場合、android_binary ルールの --android_platforms で指定されたプラットフォームごとに 1 回ビルドされ、最終出力に含まれます。

このフラグにデフォルト値はありません。カスタム Android プラットフォームを定義して使用する必要があります。

--android_platforms で指定されたプラットフォームごとに 1 つの .so ファイルが作成され、APK にパッケージ化されます。.so ファイルの名前は、android_binary ルールの名前の接頭辞として「lib」が付加されています。たとえば、android_binary の名前が「foo」の場合、ファイルは libfoo.so です。

--per_file_copt=[+-]regex[,[+-]regex]...@option[,option]...

存在する場合、包含正規表現の式のいずれかに一致し、除外式のいずれとも一致しないラベルまたは実行パスを持つ C++ ファイルは、指定されたオプションでビルドされます。ラベル照合では、正規形式のラベルを使用します(例: //package:label_name)。

実行パスは、C++ ファイルのベース名(拡張子を含む)を含むワークスペース ディレクトリへの相対パスです。プラットフォームに依存するプレフィックスも含まれます。

生成されたファイル(genrule 出力など)と一致させるために、Bazel では実行パスのみを使用できます。この場合、実行パスと一致しないため、正規表現を「//」で始めることはできません。パッケージ名は --per_file_copt=base/.*\.pb\.cc@-g0 のようになります。これは、base というディレクトリ内のすべての .pb.cc ファイルと一致します。

このオプションは複数回使用できます。

このオプションは、使用するコンパイル モードに関係なく適用されます。たとえば、--compilation_mode=opt を使用してコンパイルし、より強力な最適化をオンにしたファイル、または最適化を無効にして、一部のファイルを選択的にコンパイルできます。

注意: 一部のファイルがデバッグ シンボルで選択的にコンパイルされると、リンク時にシンボルが削除される可能性があります。これは、--strip=never を設定することで回避できます。

構文: [+-]regex[,[+-]regex]...@option[,option]... ここで、regex は正規表現を表します。この正規表現には、包含パターンを識別する + と除外パターンを識別する - を接頭辞として付けることができます。option は、C++ コンパイラに渡される任意のオプションを表します。オプションに , が含まれている場合は、\, のように引用符で囲む必要があります。最初の @ のみを使用して正規表現とオプションを区切るため、オプションに @ を含めることもできます。

: --per_file_copt=//foo:.*\.cc,-//foo:file\.cc@-O0,-fprofile-arcs は、//foo/ 内のすべての .cc ファイル(file.cc を除く)について、C++ コンパイラのコマンドラインに -O0 オプションと -fprofile-arcs オプションを追加します。

--dynamic_mode=mode

ビルドルールの linkstatic 属性とやり取りして、C++ バイナリを動的にリンクするかどうかを決定します。

モード:

  • auto: プラットフォームに依存するモードに変換します。Linux の場合は default、cygwin の場合は off です。
  • default: bazel が動的にリンクするかどうかを選択できます。詳細については、linkstatic をご覧ください。
  • fully: すべてのターゲットに動的にリンクします。これにより、リンク時間が短縮され、生成されるバイナリのサイズが削減されます。
  • off: すべてのターゲットをほぼ静的モードでリンクします。linkopts で -static が設定されている場合、ターゲットは完全に静的に変更されます。

--fission (yes|no|[dbg][,opt][,fastbuild])

Fission を有効にします。これにより、C++ デバッグ情報が .o ファイルではなく専用の .dwo ファイルに書き込まれます。これにより、リンクへの入力サイズが大幅に削減され、リンク時間を短縮できます。

[dbg][,opt][,fastbuild](例: --fission=dbg,fastbuild)に設定すると、指定されたコンパイル モードのセットでのみ、Fission が有効になります。これは bazelrc の設定に便利です。yes に設定すると、Fission が普遍的に有効になります。no に設定すると、Fission は普遍的に無効になります。デフォルトは no です。

--force_ignore_dash_static

このフラグが設定されている場合、cc_* ルールの BUILD ファイルの linkopt で -static オプションは無視されます。これは、C++ ビルド強化の回避策のみを目的としています。

--[no]force_pic

有効にすると、すべての C++ コンパイルで位置に依存しないコード(「-fPIC」)が生成されます。リンクでは PIC 以外のライブラリよりも PIC ビルド済みライブラリが優先されます。また、リンクでは位置に依存しない実行可能ファイル(「-pie」)が生成されます。デフォルトは無効になっています。

--android_resource_shrinking

android_binary ルールのリソース圧縮を実行するかどうかを選択します。android_binary ルールで shrink_resources 属性のデフォルトを設定します。詳細については、そのルールのドキュメントをご覧ください。デフォルトはオフです。

--custom_malloc=malloc-library-target

指定すると、常に指定された malloc 実装が使用され、(malloc を指定せずに)デフォルトを使用するターゲットを含むすべての malloc="target" 属性をオーバーライドします。

--crosstool_top=label

このオプションでは、ビルド中のすべての C++ コンパイルに使用するクロスツール コンパイラ スイートの場所を指定します。Bazel はこの場所で CROSSTOOL ファイルを探し、それを使用して --compiler の設定を自動的に決定します。

--host_crosstool_top=label

指定しない場合、Bazel は --crosstool_top の値を使用して、ビルド中に実行されるツールなど、実行構成内のコードをコンパイルします。このフラグの主な目的は、クロスコンパイルを有効にすることです。

--apple_crosstool_top=label

objc*、ios*、apple* ルールの推移的な deps で C/C++ ルールをコンパイルするために使用するクロスツール。それらのターゲットでは、このフラグによって --crosstool_top が上書きされます。

--compiler=version

このオプションでは、ビルド中にバイナリのコンパイルに使用する C/C++ コンパイラ バージョン(gcc-4.1.0 など)を指定します。カスタム クロスツールでビルドする場合は、このフラグを指定する代わりに CROSSTOOL ファイルを使用する必要があります。

--android_sdk=label

非推奨です。これは直接指定しないでください。

このオプションでは、Android 関連のルールのビルドに使用する Android SDK/プラットフォーム ツールチェーンと Android ランタイム ライブラリを指定します。

WORKSPACE ファイルで android_sdk_repository ルールが定義されている場合は、Android SDK が自動的に選択されます。

--java_toolchain=label

このオプションでは、Java ソースファイルのコンパイルに使用する java_ツールチェーンのラベルを指定します。

--host_java_toolchain=label

指定しない場合、bazel は --java_toolchain の値を使用して、ビルド中に実行されるツールなど、exec 構成内のコードをコンパイルします。このフラグの主な目的は、クロスコンパイルを有効にすることです。

--javabase=(label)

このオプションは、ベース Java インストールのラベルを設定します。ラベルは、bazel runbazel testjava_binary ルールと java_test ルールによってビルドされた Java バイナリに使用されます。JAVABASEJAVA「Make」変数は、このオプションから取得されます。

--host_javabase=label

このオプションは、exec 構成で使用する Java ベースインストールのラベルを設定します(JavaBuilder や Singlejar などのホストビルドツールなど)。

Java ソースファイルのコンパイルに使用される Java コンパイラは選択されません。コンパイラは、--java_toolchain オプションの設定で選択できます。

実行戦略

これらのオプションは、Bazel によるビルドの実行方法に影響します。 ビルドで生成される出力ファイルには特に影響しません。通常、その主な影響はビルドの速度です。

--spawn_strategy=strategy

このオプションでは、コマンドの実行場所と方法を制御します。

  • standalone は、コマンドをローカル サブプロセスとして実行します。この値は非推奨になりました。代わりに local を使用してください。
  • sandboxed を指定すると、ローカルマシンのサンドボックス内でコマンドが実行されます。そのためには、すべての入力ファイル、データ依存関係、ツールを、srcs 属性、data 属性、tools 属性で直接依存関係としてリストする必要があります。サンドボックスの実行をサポートしているシステムでは、Bazel によりローカル サンドボックスがデフォルトで有効になります。
  • local は、コマンドをローカル サブプロセスとして実行します。
  • worker を指定すると、永続ワーカー(存在する場合)を使用してコマンドが実行されます。
  • docker は、ローカルマシンの Docker サンドボックス内でコマンドを実行します。そのためには、Docker がインストールされている必要があります。
  • remote を指定すると、コマンドがリモートで実行されます。これは、リモート エグゼキュータが個別に構成されている場合にのみ使用できます。

--strategy mnemonic=strategy

このオプションは、コマンドの実行場所と方法を制御し、--spawn_strategy(および --genrule_strategy をニーモニック Genrule)でオーバーライドします。サポートされている戦略とその効果については、--spawn_strategy をご覧ください。

--strategy_regexp=<filter,filter,...>=<strategy>

このオプションは、特定の regex_filter に一致する説明を持つコマンドを実行する際に使用する戦略を指定します。regex_filter マッチングの詳細については、--per_file_copt をご覧ください。サポートされている戦略とその効果については、--spawn_strategy をご覧ください。

説明に一致する最後の regex_filter が使用されます。このオプションは、戦略を指定する他のフラグをオーバーライドします。

  • 例: --strategy_regexp=//foo.*\\.cc,-//foo/bar=local は、説明が //foo.*.cc と一致し、//foo/bar と一致しない場合、local 戦略を使用してアクションを実行することを意味します。
  • 例: --strategy_regexp='Compiling.*/bar=local' --strategy_regexp=Compiling=sandboxed は、sandboxed 戦略を使用して //foo/bar/baz をコンパイルしますが、順序を逆にすると local で実行されます。
  • 例: --strategy_regexp='Compiling.*/bar=local,sandboxed' は、local 戦略で //foo/bar/baz のコンパイルを実行し、失敗した場合は sandboxed にフォールバックします。

--genrule_strategy=strategy

これは、非推奨となった --strategy=Genrule=strategy の省略形です。

--jobs=n(-j)

このオプションは整数の引数を取り、ビルドの実行フェーズで同時に実行するジョブ数の上限を指定します。

--progress_report_interval=n

Bazel は、まだ完了していないジョブ(長時間実行テストなど)に関する進行状況レポートを定期的に出力します。このオプションでは、報告の頻度を設定します。進行状況は n 秒ごとに出力されます。

デフォルトは 0 です。これは増分アルゴリズムを意味します。最初のレポートは 10 秒後に出力され、その後 30 秒後に 1 分ごとに進行状況が出力されます。

--curses で指定されているように、bazel がカーソル コントロールを使用している場合、進行状況が 1 秒ごとに報告されます。

--local_{ram,cpu}_resources resources or resource expression

これらのオプションでは、ビルドとテストのアクティビティをローカルで実行するようにスケジュールするときに、Bazel で考慮できるローカル リソースの量(MB 単位の RAM、CPU 論理コア数)を指定します。整数またはキーワード(HOST_RAM または HOST_CPUS)を指定します。オプションでその後に [-|*float](例: --local_cpu_resources=2--local_ram_resources=HOST_RAM*.5--local_cpu_resources=HOST_CPUS-1)が続きます。これらのフラグは独立しており、1 つまたは両方を設定できます。デフォルトでは、Bazel はローカル システムの構成から直接、RAM の量と CPU コア数を推定します。

このオプション(デフォルトで有効)は、テストとバイナリの runfile シンボリック リンクを出力ディレクトリにビルドするかどうかを指定します。--nobuild_runfile_links を使用すると、runfiles ツリーのビルドに関するオーバーヘッドを発生させることなく、すべてのターゲットがコンパイルされるかどうかを検証できます。

テスト(またはアプリケーション)が実行されると、ランタイム データ依存関係が 1 か所に集約されます。Bazel の出力ツリー内では、この「runfiles」ツリーは通常、対応するバイナリまたはテストの兄弟ノードとしてルート化されます。テスト実行中、実行ファイルは $TEST_SRCDIR/workspace/packagename/filename という形式のパスを使用してアクセスできます。runfiles ツリーにより、テストは依存関係が宣言されているすべてのファイルに、それ以外のものにはアクセスできなくなります。デフォルトでは、runfiles ツリーは必要なファイルへのシンボリック リンクのセットを構築することで実装されます。リンクのセットが大きくなると、この処理のコストも増加します。また、一部の大規模なビルドでは、特に個々のテスト(またはアプリケーション)に独自の実行ファイル ツリーが必要になるため、全体的なビルド時間が大幅に増加する可能性があります。

--[no]build_runfile_manifests

このオプションはデフォルトで有効になっており、runfiles マニフェストを出力ツリーに書き込むかどうかを指定します。無効にすると、--nobuild_runfile_links が含まれます。

リモートでテストを実行する場合は、runfile ツリーはメモリ内マニフェストからリモートで作成されるため、無効にできます。

--[no]discard_analysis_cache

このオプションを有効にすると、Bazel は実行が開始する直前に分析キャッシュを破棄し、実行フェーズ用に追加のメモリ(約 10%)を解放します。欠点は、それ以上の増分ビルドに時間がかかることです。メモリ節約モードもご覧ください。

--[no]keep_going(-k)

GNU Make と同様に、ビルドの実行フェーズは、最初のエラーが発生すると停止します。エラーがあってもできる限り ビルドしてみるのが便利な場合もありますこのオプションを使用すると、この動作が有効になります。指定すると、ビルドは前提条件が正常にビルドされたすべてのターゲットのビルドを試みますが、エラーを無視します。

このオプションは通常、ビルドの実行フェーズに関連付けられますが、分析フェーズにも影響します。ビルドコマンドに複数のターゲットを指定しても、そのターゲットの一部しか正常に分析できない場合、--keep_going が指定されない限り、ビルドはエラーで停止します。その場合、ビルドは実行フェーズに進みますが、分析に成功したターゲットのみが対象となります。

--[no]use_ijars

このオプションにより、Bazel による java_library ターゲットのコンパイル方法が変更されます。Bazel は、依存する java_library ターゲットのコンパイルに java_library の出力を使用する代わりに、非プライベート メンバー(公開、保護、デフォルト(パッケージ)のアクセスメソッドとフィールド)の署名のみを含むインターフェース jar を作成し、そのインターフェース jar を使用して依存ターゲットをコンパイルします。これにより、メソッド本体またはクラスのプライベート メンバーにのみ変更が行われた場合に、再コンパイルを回避できます。

--[no]interface_shared_objects

このオプションを使用すると、インターフェース共有オブジェクトが有効になります。これにより、バイナリやその他の共有ライブラリは、実装ではなく共有オブジェクトのインターフェースに依存します。実装のみが変更された場合、Bazel は、変更された共有ライブラリに不必要に依存するターゲットの再ビルドを回避できます。

出力の選択

これらのオプションにより、ビルドまたはテストの対象が決まります。

--[no]build

このオプションにより、ビルドの実行フェーズが発生します。これはデフォルトで有効になっています。オフにすると、実行フェーズはスキップされ、最初の 2 つのフェーズ(読み込みと分析)のみが発生します。

このオプションは、実際に何もビルドせずに、BUILD ファイルを検証し、入力のエラーを検出するのに役立ちます。

--[no]build_tests_only

指定すると、サイズタイムアウトタグ、または言語が原因でフィルタリングされなかった *_test ルールと test_suite ルールの実行に必要なもののみをビルドします。これを指定すると、Bazel はコマンドラインで指定された他のターゲットを無視します。 デフォルトでは、このオプションは無効になっており、Bazel は、テストから除外された *_test ルールと test_suite ルールを含む、リクエストされたすべてのものをビルドします。bazel test --build_tests_only foo/... を実行しても foo ツリー内のすべてのビルド破損が検出されるとは限らないため、これは便利です。

--[no]check_up_to_date

このオプションを使用すると、Bazel はビルドを実行せず、指定されたすべてのターゲットが最新かどうかを確認するだけです。その場合、ビルドは通常どおり正常に完了します。ただし、古いファイルがある場合は、ビルドされずにエラーが報告され、ビルドは失敗します。このオプションは、ビルドのコストを発生させずに、ビルドがソースの編集よりも最近実行されたかどうかを判断するのに役立ちます(送信前のチェックなど)。

--check_tests_up_to_date もご覧ください。

--[no]compile_one_dependency

引数ファイルの単一の依存関係をコンパイルします。これは、IDE でソースファイルの構文チェックを行う場合に便利です。たとえば、編集/ビルド/テストサイクルのできるだけ早い段階でエラーを検出するために、ソースファイルに依存する単一のターゲットを再ビルドする場合などです。この引数は、フラグ以外のすべての引数の解釈方法に影響します。各引数は、ファイル ターゲット ラベルまたは現在の作業ディレクトリに関連するプレーン ファイル名でなければならず、各ソースファイル名に依存する 1 つのルールが作成されます。C++ ソースと Java ソースの場合は、同じ言語空間のルールが優先的に選択されます。同じ設定を持つ複数のルールの場合は、BUILD ファイルで最初に出現するルールが選択されます。明示的に指定されたターゲット パターンがソースファイルを参照しない場合は、エラーが発生します。

--save_temps

--save_temps オプションを使用すると、コンパイラからの一時的な出力が保存されます。これには、.s ファイル(アセンブラ コード)、.i(前処理された C)、.ii(前処理された C++)ファイルが含まれます。多くの場合、これらの出力はデバッグに役立ちます。一時ファイルは、コマンドラインで指定された一連のターゲットに対してのみ生成されます。

現在、--save_temps フラグは cc_* ルールに対してのみ機能します。

Bazel が追加の出力ファイルの場所を出力するように、--show_result n の設定が十分であることを確認します。

--build_tag_filters=tag[,tag]*

指定すると、Bazel は、必須タグが 1 つ以上指定されていて、除外されたタグがないターゲットのみをビルドします。ビルドタグ フィルタは、タグキーワードのカンマ区切りのリストとして指定します。除外されるタグを示すために、必要に応じてその前に「-」記号を付けます。必須タグの前に「+」記号を付けることもできます。

テストの実行時、Bazel はテスト ターゲットの --build_tag_filters を無視します。テスト ターゲットは、このフィルタに一致していなくてもビルドされて実行されます。ビルドを回避するには、--test_tag_filters を使用するか、明示的に除外することで、テスト ターゲットをフィルタリングします。

--test_size_filters=size[,size]*

指定すると、指定されたサイズのターゲットのみがテスト(--build_tests_only も指定されている場合はビルド)されます。テストサイズ フィルタは、許可されるテストサイズ値(小、中、大、巨大)のカンマ区切りのリストとして指定します。また、除外するテストサイズを示す「-」記号を先頭に付けることもできます。たとえば

  % bazel test --test_size_filters=small,medium //foo:all

and

  % bazel test --test_size_filters=-large,-enormous //foo:all

//foo 内の小規模および中規模のテストのみをテストします。

デフォルトでは、テストサイズのフィルタリングは適用されません。

--test_timeout_filters=timeout[,timeout]*

指定すると、指定されたタイムアウト時間のターゲットのみがテストされます(--build_tests_only も指定されている場合はビルドされます)。テストのタイムアウト フィルタは、許可されるテスト タイムアウト値(short、moderate、long、eternal)のカンマ区切りのリストとして指定します。また、除外されるテスト タイムアウトを示す「-」記号を前に付けることもできます。構文の例については、--test_size_filters をご覧ください。

デフォルトでは、テストのタイムアウト フィルタリングは適用されません。

--test_tag_filters=tag[,tag]*

指定すると、Bazel は必須タグ(指定されている場合)が 1 つ以上あり、除外されたタグがないターゲットのみをテスト(--build_tests_only も指定されている場合はビルド)します。テストタグ フィルタは、タグキーワードのカンマ区切りのリストとして指定します。除外されるタグを示すために、必要に応じてその前に「-」記号を付けます。必須タグの前に「+」記号を付けることもできます。

たとえば

  % bazel test --test_tag_filters=performance,stress,-flaky //myproject:all

performance タグまたは stress タグのいずれかがタグ付けされ、flaky タグが付けられていないターゲットをテストします。

デフォルトでは、テストタグのフィルタリングは適用されません。この方法でテストの size タグと local タグをフィルタすることもできます。

--test_lang_filters=string[,string]*

テストルールクラスの名前を参照する文字列のカンマ区切りリストを指定します。ルールクラス foo_test を参照するには、文字列「foo」を使用します。Bazel は、参照先のルールクラスのターゲットのみをテスト(--build_tests_only も指定されている場合はビルド)します。そのようなターゲットを除外するには、文字列 "-foo" を使用します。たとえば

  % bazel test --test_lang_filters=foo,bar //baz/...

//baz/...foo_test または bar_test のインスタンスであるターゲットのみをテストしますが、

  % bazel test --test_lang_filters=-foo,-bar //baz/...

foo_test インスタンスと bar_test インスタンスを除く、//baz/... のすべてのターゲットをテストします。

--test_filter=filter-expression

テストランナーが実行するテストのサブセットを選択するために使用できるフィルタを指定します。呼び出しで指定されたすべてのターゲットがビルドされますが、式によっては、ターゲットの一部のみが実行されます。特定のテストメソッドのみが実行される場合もあります。

filter-expression の具体的な解釈は、テストを実行するテスト フレームワークによって異なります。glob、部分文字列、または正規表現を使用できます。--test_filter は、さまざまな --test_arg フィルタ引数を渡す場合に便利ですが、すべてのフレームワークがサポートしているわけではありません。

読み上げの詳細設定

これらのオプションは、ターミナルまたは追加のログファイルへの Bazel の出力の詳細度を制御します。

--explain=logfile

このオプションにはファイル名引数が必要です。このオプションを使用すると、bazel build の実行フェーズの依存関係チェッカーにより、ビルドステップごとに、ビルドステップの実行理由や最新性のいずれかが説明されます。説明は logfile に書き込まれます。

予期しない再ビルドが発生した場合は、このオプションを使用して理由を確認できます。.bazelrc に追加して、後続のすべてのビルドでロギングが行われるようにします。その後、実行ステップが予期せず実行された場合にログを調べます。このオプションを使用すると、パフォーマンスがわずかに低下する可能性があるため、不要になったら削除することをおすすめします。

--verbose_explanations

このオプションは、--explain オプションが有効な場合に生成される説明の詳細度を高めます。

特に、詳細説明が有効で、ビルドに使用したコマンドが変更されたために出力ファイルが再ビルドされた場合、説明ファイルの出力には新しいコマンドの詳細が含まれます(少なくともほとんどのコマンドの場合)。

このオプションを使用すると、生成される説明ファイルの長さが大幅に増加し、--explain の使用によるパフォーマンスが低下する可能性があります。

--explain が有効になっていない場合、--verbose_explanations の効果はありません。

--profile=file

このオプションはファイル名引数を受け取り、Bazel はプロファイリング データをファイルに書き込みます。その後、bazel analyze-profile コマンドを使用してデータを分析または解析できます。ビルド プロファイルは、Bazel の build コマンドがどこで処理に時間がかかっているのかを把握するのに役立ちます。

--[no]show_loading_progress

このオプションを使用すると、Bazel がパッケージ読み込みの進行状況メッセージを出力します。無効にすると、メッセージは表示されません。

--[no]show_progress

このオプションを使用すると、進行状況メッセージが表示されます。これはデフォルトでオンになっています。無効にすると、進行状況メッセージが非表示になります。

--show_progress_rate_limit=n

このオプションにより、bazel は n 秒ごとに最大 1 つの進行状況メッセージを表示します。ここで、n は実数です。このオプションのデフォルト値は 0.02 です。つまり、bazel は進行状況メッセージを 0.02 秒ごとに 1 つに制限します。

--show_result=n

このオプションは、bazel build コマンドの最後で結果情報を出力するかを制御します。単一のビルド ターゲットが指定されている場合、デフォルトでは、ターゲットが正常に更新されたかどうかを示すメッセージと、ターゲットが作成した出力ファイルのリストが出力されます。複数のターゲットが指定されている場合、結果情報は表示されません。

結果情報は、1 つのターゲットや少数のターゲットのビルドでは有用ですが、大規模なビルド(トップレベルのプロジェクト ツリー全体など)では、この情報が多すぎて気が散る可能性があります。このオプションにより、制御が可能になります。--show_result は整数の引数を取ります。これは、すべての結果情報を出力するターゲットの最大数です。デフォルト値は 1 です。このしきい値を超えると、個々のターゲットの結果情報は表示されません。ゼロの場合、結果情報は常に抑制され、値が非常に大きい場合、結果が常に出力されます。

小規模なターゲット グループの構築(コンパイル、編集、テストのサイクル中など)と大規模なターゲット グループの作成(新しいワークスペースの確立時や回帰テストの実行時など)を定期的に繰り返す場合は、中間の値を選択します。前者の場合、結果情報は非常に有用ですが、後者の場合はあまり役に立ちません。他のオプションと同様に、これは .bazelrc ファイルを使用して暗黙的に指定できます。

これらのファイルは、ファイル名を簡単にコピーしてシェルに貼り付け、ビルドされた実行可能ファイルを実行できるように出力されます。各ターゲットの「最新」または「失敗」メッセージは、ビルドを実行するスクリプトによって簡単に解析できます。

--sandbox_debug

アクションの実行にサンドボックス化を使用すると、Bazel で追加のデバッグ情報が出力されます。このオプションではサンドボックス ディレクトリも保持されるため、実行中にアクションに表示されるファイルを調べることができます。

--subcommands-s

このオプションを使用すると、Bazel の実行フェーズで、各コマンドの実行前にコマンドライン全体を出力します。

  >>>>> # //examples/cpp:hello-world [action 'Linking examples/cpp/hello-world']
  (cd /home/johndoe/.cache/bazel/_bazel_johndoe/4c084335afceb392cfbe7c31afee3a9f/bazel && \
    exec env - \
    /usr/bin/gcc -o bazel-out/local-fastbuild/bin/examples/cpp/hello-world -B/usr/bin/ -Wl,-z,relro,-z,now -no-canonical-prefixes -pass-exit-codes -Wl,-S -Wl,@bazel-out/local_linux-fastbuild/bin/examples/cpp/hello-world-2.params)

可能な場合、コマンドは Bourne シェル互換の構文で出力されるため、簡単にコピーしてシェルのコマンド プロンプトに貼り付けることができます。(かっこは、シェルを cdexec の呼び出しから保護するために用意されています。必ずコピーしてください)。ただし、シンボリック リンク ツリーの作成など、一部のコマンドは Bazel 内に内部で実装されています。これらについては、表示するコマンドラインはありません。

--subcommands=pretty_print を渡すと、コマンドの引数が 1 行ではなくリストとして出力されます。これにより、長いコマンドラインが読みやすくなる可能性があります。

以下の --verbose_failures もご覧ください。

ツールに適した形式でファイルにサブコマンドをロギングする方法については、--execution_log_json_file--execution_log_binary_file をご覧ください。

--verbose_failures

このオプションを使用すると、Bazel の実行フェーズで、失敗したコマンドの完全なコマンドラインが出力されます。これは、失敗したビルドのデバッグに役立ちます。

失敗したコマンドは Bourne シェル互換の構文で出力されます。コピーしてシェル プロンプトに貼り付けるのに適しています。

ワークスペースのステータス

これらのオプションを使用して、Bazel でビルドされたバイナリを「スタンプ」できます。ソース管理のリビジョンやその他のワークスペース関連情報など、追加情報をバイナリに埋め込みます。このメカニズムは、genrulecc_binary など、stamp 属性をサポートするルールで使用できます。

--workspace_status_command=program

このフラグを使用すると、各ビルドの前に Bazel が実行するバイナリを指定できます。プログラムは、現在のソース管理リビジョンなど、ワークスペースのステータスに関する情報を報告できます。

フラグの値には、ネイティブ プログラムへのパスを指定する必要があります。Linux/macOS では、任意の実行可能ファイルの可能性があります。Windows では、これはネイティブ バイナリ、通常は「.exe」、「.bat」、「.cmd」ファイルである必要があります。

プログラムは 0 個以上の Key-Value ペアを標準出力に出力します。1 行に 1 エントリが出力され、その後、ゼロで終了します(そうでない場合、ビルドは失敗します)。キー名には任意の名前を付けることができますが、使用できるのは大文字とアンダースコアのみです。キー名の後の最初のスペースは、キーと値を区切ります。値は行の残りの部分(追加の空白を含む)です。キーも値も複数行にまたがってはなりません。キーは重複してはいけません。

Bazel はキーを「stable」と「volatile」の 2 つのバケットに分割します。(「stable」と「volatile」という名前は少しわかりにくいため、あまり考えないでください)。

次に、Bazel は Key-Value ペアを 2 つのファイルに書き込みます。

  • bazel-out/stable-status.txt には、キーの名前が STABLE_ で始まるすべてのキーと値が含まれます。
  • bazel-out/volatile-status.txt には残りのキーとその値が含まれます。

契約の内容は次のとおりです。

  • 「安定した」キーの値は、可能な限りめったに変更しないようにします。bazel-out/stable-status.txt の内容が変更されると、Bazel はそれらに依存するアクションを無効にします。つまり、安定したキーの値が変更されると、Bazel はスタンプ付きのアクションを再実行します。したがって、安定版のステータスにはタイムスタンプなどが含まれないようにする必要があります。タイムスタンプなどは、常に変更され、ビルドごとに Bazel がスタンプ付きのアクションを再実行するためです。

    Bazel は、常に次の安定したキーを出力します。

    • BUILD_EMBED_LABEL: --embed_label の値
    • BUILD_HOST: Bazel が実行されているホストマシンの名前
    • BUILD_USER: Bazel が実行されているユーザーの名前
  • 「volatile」キーの値は頻繁に変更される可能性があります。Bazel は、タイムスタンプと同様にすべての時間が変更されることを想定し、bazel-out/volatile-status.txt ファイルを適切に更新します。ただし、スタンプ付きのアクションが繰り返し再実行されないように、Bazel は揮発性ファイルが変更されていないと仮定します。つまり、揮発性ステータス ファイルだけが内容が変更されたファイルである場合、Bazel はそれに依存するアクションを無効にしません。アクションの他の入力が変更された場合、Bazel はそのアクションを再実行し、更新された volatile ステータスを確認しますが、volatile ステータスが変更されただけではアクションは無効になりません。

    Bazel は、常に次の揮発性キーを出力します。

    • BUILD_TIMESTAMP: ビルドの時間(Unix エポックからの経過秒数)(System.currentTimeMillis() の値を 1,000 で割った値)
    • FORMATTED_DATE: ビルドの時刻。UTC で yyyy MMM d HH mm ss EEE としてフォーマットされます(例: 2023 6 2 01 44 29 金)。

Linux/macOS では、--workspace_status_command=/bin/true を渡してワークスペースのステータスの取得を無効にできます。これは、true は何もせず、正常に終了し(ゼロで終了します)、出力がないためです。Windows では、MSYS の true.exe のパスを渡して同じ効果を得ることができます。

なんらかの理由で workspace status コマンドが失敗する(ゼロ以外で終了)場合、ビルドは失敗します。

Git を使用した Linux 上のプログラムの例:

#!/bin/bash
echo "CURRENT_TIME $(date +%s)"
echo "RANDOM_HASH $(cat /proc/sys/kernel/random/uuid)"
echo "STABLE_GIT_COMMIT $(git rev-parse HEAD)"
echo "STABLE_USER_NAME $USER"

このプログラムのパスを --workspace_status_command で渡すと、安定版のステータス ファイルに STABLE 行が含まれ、揮発性ステータス ファイルに残りの行が含まれます。

--[no]stamp

このオプションは、stamp ルール属性と組み合わせて使用し、ビルド情報をバイナリに埋め込むかどうかを制御します。

スタンプは、stamp 属性を使用してルールごとに明示的に有効または無効にできます。詳しくは、Build 百科事典をご覧ください。ルールで stamp = -1*_binary ルールのデフォルト)が設定されている場合、このオプションによりスタンプが有効かどうかが決まります。

このオプションまたは stamp 属性に関係なく、Bazel は実行構成用にビルドされたバイナリをスタンプしません。stamp = 0*_test ルールのデフォルト)を設定するルールでは、--[no]stamp に関係なくスタンプが無効になります。--stamp を指定しても、ターゲットの依存関係が変更されていなければ、ターゲットは強制的に再ビルドされません。

--nostamp を設定すると、入力の変動性が軽減され、ビルド キャッシュが最大化されるため、通常はビルドのパフォーマンスが向上します。

プラットフォーム

これらのオプションを使用すると、ビルドの動作を構成するホスト プラットフォームとターゲット プラットフォームを制御できます。また、Bazel ルールで使用できる実行プラットフォームとツールチェーンを制御できます。

プラットフォームツールチェーンの背景情報をご参照ください。

--platforms=labels

現在のコマンドのターゲット プラットフォームを記述するプラットフォーム ルールのラベル。

--host_platform=label

ホストシステムを記述するプラットフォーム ルールのラベル。

--extra_execution_platforms=labels

アクションを実行するための実行プラットフォームとして利用可能なプラットフォーム。プラットフォームは、正確なターゲットで、またはターゲット パターンとして指定できます。これらのプラットフォームは、register_execution_platforms() によって WORKSPACE ファイルで宣言されたプラットフォームより先に検討されます。このオプションには、プラットフォームのカンマ区切りのリスト(優先度順)を指定できます。フラグが複数回渡された場合は、最新のオーバーライド。

--extra_toolchains=labels

ツールチェーンの解決時に考慮されるツールチェーン ルール。ツールチェーンは正確なターゲットで指定することも、ターゲット パターンとして指定することもできます。これらのツールチェーンは、register_toolchains() によって WORKSPACE ファイル内で宣言されたものよりも前に考慮されます。

--toolchain_resolution_debug=regex

ツールチェーン タイプが正規表現と一致する場合、ツールチェーンの検索中にデバッグ情報を出力します。複数の正規表現はカンマで区切って指定できます。先頭に - を使用すると、正規表現を反転できます。これは、Bazel ルールまたは Starlark ルールのデベロッパーが、ツールチェーンの欠落が原因でデバッグが失敗する場合に役立ちます。

その他

--flag_alias=alias_name=target_path

長い Starlark ビルド設定を短い名前にバインドするために使用されるコンビニエンス フラグ。詳細については、Starlark 構成をご覧ください。

生成されたコンビニエンス シンボリック リンクのプレフィックスを変更します。シンボリック リンク プレフィックスのデフォルト値は bazel- です。これにより、シンボリック リンク bazel-binbazel-testlogsbazel-genfiles が作成されます。

なんらかの理由でシンボリック リンクを作成できない場合、警告が発行されますが、ビルドは成功したとみなされます。これにより、読み取り専用のディレクトリや書き込み権限のないディレクトリでビルドできるようになります。ビルドの終了時に情報メッセージに出力されるパスは、シンボリック リンクが予期される場所を指している場合のみ、シンボリック リンク相対短縮形を使用します。つまり、作成されるシンボリック リンクに依存できない場合でも、これらのパスの正確性を信頼できます。

このオプションの一般的な値は次のとおりです。

  • シンボリック リンクの作成を抑制する: --symlink_prefix=/ は、Bazel がシンボリック リンク(bazel-outbazel-<workspace> など)を作成または更新しなくなります。このオプションを使用すると、シンボリック リンクの作成を完全に抑止できます。

  • 見やすくなる: --symlink_prefix=.bazel/ を使用すると、Bazel が非表示ディレクトリ .bazel 内に bin などのシンボリック リンクを作成します。

--platform_suffix=string

構成の略称に接尾辞を追加します。これは、出力ディレクトリの決定に使用されます。このオプションを異なる値に設定すると、ファイルは別のディレクトリに配置されます。たとえば、互いの出力ファイルを上書きするビルドのキャッシュ ヒット率を改善したり、比較のために出力ファイルを保持したりできます。

--default_visibility=(private|public)

bazel のデフォルトの公開設定の変更をテストするための一時的なフラグ。一般的な使用を意図したものではありませんが、完全性を期すために文書化されています。

--starlark_cpu_profile=_file_

このフラグ(値はファイルの名前)で、Bazel はすべての Starlark スレッドによる CPU 使用率に関する統計情報を収集し、pprof 形式でプロファイルを指定されたファイルに書き込みます。

このオプションを使用すると、過剰な計算によって読み込みや分析が遅くなる Starlark 関数を特定できます。次に例を示します。

$ bazel build --nobuild --starlark_cpu_profile=/tmp/pprof.gz my/project/...
$ pprof /tmp/pprof.gz
(pprof) top
Type: CPU
Time: Feb 6, 2020 at 12:06pm (PST)
Duration: 5.26s, Total samples = 3.34s (63.55%)
Showing nodes accounting for 3.34s, 100% of 3.34s total
      flat  flat%   sum%        cum   cum%
     1.86s 55.69% 55.69%      1.86s 55.69%  sort_source_files
     1.02s 30.54% 86.23%      1.02s 30.54%  expand_all_combinations
     0.44s 13.17% 99.40%      0.44s 13.17%  range
     0.02s   0.6%   100%      3.34s   100%  sorted
         0     0%   100%      1.38s 41.32%  my/project/main/BUILD
         0     0%   100%      1.96s 58.68%  my/project/library.bzl
         0     0%   100%      3.34s   100%  main

同じデータを別のビューに表示するには、pprof コマンド svgweblist を試してください。

リリースに Bazel を使用する

Bazel は、開発サイクル中のソフトウェア エンジニアと、本番環境にデプロイするバイナリを準備するリリース エンジニアの両方で使用されます。このセクションでは、Bazel を使用するリリース エンジニア向けのヒントを紹介します。

重要なオプション

リリースビルドに Bazel を使用すると、ビルドを実行する他のスクリプトと同じ問題が発生します。詳細については、スクリプトから Bazel を呼び出すをご覧ください。特に、次のオプションを強くおすすめします。

これらのオプションも重要です。

  • --package_path
  • --symlink_prefix: 複数の構成のビルドを管理する場合は、「64 ビット」と「32 ビット」などの個別の識別子で各ビルドを区別すると便利です。このオプションは、bazel-bin などのシンボリック リンクを区別します。

テストの実行

bazel でテストをビルドして実行するには、bazel test に続けてテスト ターゲットの名前を入力します。

デフォルトでは、このコマンドはビルドとテスト アクティビティを同時に実行します。つまり、前提条件がビルドされるとすぐに、指定されたすべてのターゲット(コマンドラインで指定されたテスト以外のターゲットを含む)をビルドし、*_test ターゲットと test_suite ターゲットをテストします。つまり、テスト実行はビルドにインターリーブされます。これにより、通常は速度が大幅に向上します。

bazel test」のオプション

--cache_test_results=(yes|no|auto)-t

このオプションを「auto」(デフォルト)に設定した場合、Bazel は次のいずれかの条件に該当する場合にのみテストを再実行します。

  • Bazel がテストまたはその依存関係の変更を検出する
  • テストは external とマークされます。
  • --runs_per_test で複数のテスト実行がリクエストされました
  • テストが失敗しました。

「no」の場合、すべてのテストが無条件に実行されます。

「yes」の場合、キャッシュの動作は auto と同じですが、--runs_per_test でテストの失敗とテスト実行がキャッシュに保存される点が異なります。

.bazelrc ファイルでこのオプションをデフォルトで有効にしている場合は、-t(オン)または -t-(オフ)という略語が、特定の実行でデフォルトをオーバーライドするのに便利です。

--check_tests_up_to_date

このオプションは、テストを実行せず、キャッシュに保存されたテスト結果の確認と報告のみを行うよう Bazel に指示します。以前にビルドおよび実行されていないテストや、テスト結果が古くなっている(ソースコードやビルド オプションが変更されたなど)場合、Bazel はエラー メッセージ(「テスト結果が最新ではありません」)を報告し、テストのステータスを「NO STATUS」(カラー出力が有効な場合は赤色)として記録し、終了コードを返します。

このオプションは、[--check_up_to_date](#check-up-to-date) の動作も暗黙的に示唆します。

このオプションは送信前のチェックに役立ちます。

--test_verbose_timeout_warnings

このオプションは、テストのタイムアウトがテストの実際の実行時間よりも大幅に長い場合にユーザーに明示的に警告するよう Bazel に指示します。テストのタイムアウトは不安定にならないように設定する必要がありますが、タイムアウトが長すぎるテストでは、予期せず発生する実際の問題が隠れてしまう可能性があります。

たとえば、通常は 1 ~ 2 分で実行されるテストの場合、ETERNAL や LONG のタイムアウトはあまりにも緩すぎるため設定しないでください。

このオプションは、ユーザーが適切なタイムアウト値を決定する場合や、既存のタイムアウト値をサニティ チェックする場合に役立ちます。

--[no]test_keep_going

デフォルトでは、すべてのテストが最後まで実行されます。ただし、このフラグが無効になっている場合、ビルドは合格していないテストで中止されます。後続のビルドステップとテスト呼び出しは実行されず、処理中の呼び出しはキャンセルされます。--notest_keep_going--keep_going の両方を指定しないでください。

--flaky_test_attempts=attempts

このオプションは、なんらかの理由でテストが失敗した場合に、テストを試行する最大回数を指定します。最初は失敗し、最終的に成功したテストは、テストサマリーに FLAKY として報告されます。ただし、Bazel 終了コードまたは合格したテストの合計数を特定する場合は合格とみなされます。許可されたすべての試行が失敗するテストは、失敗したとみなされます。

デフォルト(このオプションが指定されていない場合、またはデフォルトに設定されている場合)では、通常のテストでは 1 回の試行のみが許可され、flaky 属性が設定されたテストルールでは 3 回の試行が許可されます。整数値を指定して、テストの試行回数の上限をオーバーライドできます。Bazel では、システムの不正使用を防ぐため、最大 10 回のテストを試行できます。

--runs_per_test=[regex@]number

このオプションでは、各テストを実行する回数を指定します。すべてのテスト実行は別々のテストとして扱われます(フォールバック機能は各テストに独立して適用されます)。

実行に失敗したターゲットのステータスは、--runs_per_test_detects_flakes フラグの値によって異なります。

  • 存在しない場合、実行が失敗すると、テスト全体が失敗します。
  • 同じシャードからの実行が 2 つあり、PASS と FAIL が返されると、テストのステータスは不安定になります(他の実行の失敗によって不合格にならない限り)。

単一の数値を指定すると、すべてのテストがその回数だけ実行されます。また、正規表現は、regex@number 構文を使用して指定できます。これにより、--runs_per_test の影響が正規表現に一致するターゲットに制限されます(--runs_per_test=^//pizza:.*@4//pizza/ の下にあるすべてのテストを 4 回実行します)。この形式の --runs_per_test は複数回指定できます。

--[no]runs_per_test_detects_flakes

このオプションが指定されている場合(デフォルトでは指定されていません)、Bazel は --runs_per_test を通じて不安定なテストシャードを検出します。1 つのシャードに対する 1 つ以上の実行が失敗し、同じシャードパスに対して 1 つ以上の実行が失敗した場合、フラグはターゲットが不安定と見なされます。指定しない場合、ターゲットは失敗ステータスを報告します。

--test_summary=output_style

テスト結果の概要の表示方法を指定します。

  • short は、各テストの結果と、テストが失敗した場合はテスト出力を含むファイルの名前を出力します。これがデフォルト値です。
  • terseshort に似ていますが、さらに短くします。合格しなかったテストに関する情報のみを出力します。
  • detailed は、各テストだけでなく、失敗した個々のテストケースを出力します。テスト出力ファイルの名前は省略されます。
  • none はテストサマリーを出力しません。

--test_output=output_style

テスト出力の表示方法を指定します。

  • summary には、各テストの合格または不合格の概要が表示されます。失敗したテストの出力ログファイル名も表示されます。概要はビルドの最後に出力されます(ビルド中は、テストの開始時、合格時、失敗時に、進行状況を示すシンプルなメッセージが表示されます)。これがデフォルト設定です。
  • errors は、失敗したテストの stdout/stderr 出力を、テスト完了直後にのみ stdout に送信し、同時テストからのテスト出力が互いにインターリーブされないようにします。上記のサマリー出力のとおり、ビルド時にサマリーを出力します。
  • allerrors に似ていますが、合格したテストを含むすべてのテストの出力を出力します。
  • streamed は、各テストの stdout/stderr 出力をリアルタイムでストリーミングします。

--java_debug

このオプションを使用すると、Java テストの Java 仮想マシンは、JDWP 準拠のデバッガからの接続を待機してからテストを開始します。このオプションは --test_output=streamed を意味します。

--[no]verbose_test_summary

このオプションはデフォルトで有効になっています。テスト時間やその他の追加情報(テスト試行など)がテストサマリーに出力されます。--noverbose_test_summary を指定した場合、テストサマリーには、テスト名、テスト ステータス、キャッシュされたテスト インジケーターのみが含まれ、可能な限り 80 文字以内に収まるようにフォーマットされます。

--test_tmpdir=path

ローカルで実行するテストの一時ディレクトリを指定します。各テストは、このディレクトリ内の個別のサブディレクトリで実行されます。このディレクトリは、各 bazel test コマンドの開始時に消去されます。デフォルトでは、bazel はこのディレクトリを Bazel 出力ベース ディレクトリに配置します。

--test_timeout=seconds または --test_timeout=seconds,seconds,seconds,seconds

指定された秒数を新しいタイムアウト値として使用して、すべてのテストのタイムアウト値をオーバーライドします。値を 1 つだけ指定した場合、その値がすべてのテスト タイムアウト カテゴリに使用されます。

または、4 つのカンマ区切り値を指定して、短期、中程度、長期、eternal のテストに対する個別のタイムアウトを(この順序で)指定することもできます。どちらの形式でも、テストの作成ページで定義されているタイムアウト カテゴリのデフォルトのタイムアウトは、いずれかのテストサイズに対する 0 または負の値に置き換えられます。デフォルトでは、Bazel はサイズが暗黙的に設定されているか明示的に設定されているかにかかわらず、テストのサイズからタイムアウト上限を推定して、すべてのテストでこれらのタイムアウトを使用します。

タイムアウト カテゴリがサイズと異なることを明示したテストは、そのタイムアウトがサイズタグによって暗黙的に設定された場合と同じ値を受け取ります。したがって、「long」タイムアウトを宣言するサイズ「small」のテストは、明示的なタイムアウトなしに「large」テストの場合と同じ実効タイムアウトになります。

--test_arg=arg

コマンドラインのオプション/フラグ/引数を各テストプロセスに渡します。このオプションを複数回使用して、複数の引数を渡すことができます。次に例を示します。 --test_arg=--logtostderr --test_arg=--v=3

bazel run コマンドとは異なり、bazel test -- target --logtostderr --v=3 のようにテスト引数を直接渡すことはできません。これは、bazel test に渡された余分な引数が追加のテスト ターゲットとして解釈されるためです。つまり、--logtostderr--v=3 はそれぞれテスト ターゲットとして解釈されます。1 つのターゲットのみを受け入れる bazel run コマンドには、このあいまいさはありません。

--test_argbazel run コマンドに渡すことはできますが、実行されるターゲットがテスト ターゲットでない限り無視されます。(他のフラグと同様に、-- トークンの後に bazel run コマンドで渡されると、Bazel で処理されず、実行されたターゲットにそのまま転送されます)。

--test_env=variable=_value_ または --test_env=variable

各テストのテスト環境に挿入する必要がある追加の変数を指定します。value が指定されていない場合は、bazel test コマンドの起動に使用されるシェル環境から継承されます。

テスト内から環境にアクセスするには、System.getenv("var")(Java)、getenv("var")(C または C++)、

--run_under=command-prefix

これは、テストランナーが実行前にテストコマンドの前に挿入する接頭辞を指定します。command-prefix は、Bourne シェルのトークン化ルールを使用して単語に分割され、実行されるコマンドの先頭に単語のリストが付加されます。

最初の単語が完全修飾ラベル(// で始まる)の場合はビルドされます。ラベルは対応する実行可能な場所に置き換えられ、他の単語と一緒に実行されるコマンドの先頭に付加されます。

次の点に注意してください。

  • テストの実行に使用する PATH は、実際の環境の PATH と異なる場合があるため、--run_under コマンドに絶対パスcommand-prefix の最初の単語)を使用する必要があります。
  • stdin は接続されていないため、--run_under は対話型コマンドに使用できません。

例:

        --run_under=/usr/bin/strace
        --run_under='/usr/bin/strace -c'
        --run_under=/usr/bin/valgrind
        --run_under='/usr/bin/valgrind --quiet --num-callers=20'

テストの選択

出力選択オプションで説明されているように、サイズタイムアウトタグ、または言語でテストをフィルタできます。便利な一般名フィルタを使用すると、特定のフィルタ引数をテストランナーに転送できます。

bazel test」のその他のオプション

構文と残りのオプションは、bazel build とまったく同じです。

実行可能ファイルの実行

bazel run コマンドは bazel build と似ていますが、単一のターゲットのビルドと実行に使用する点が異なります。一般的なセッションは次のとおりです。

  % bazel run java/myapp:myapp -- --arg1 --arg2
  Welcome to Bazel
  INFO: Loading package: java/myapp
  INFO: Loading package: foo/bar
  INFO: Loading complete.  Analyzing...
  INFO: Found 1 target...
  ...
  Target //java/myapp:myapp up-to-date:
    bazel-bin/java/myapp:myapp
  INFO: Elapsed time: 0.638s, Critical Path: 0.34s

  INFO: Running command line: bazel-bin/java/myapp:myapp --arg1 --arg2
  Hello there
  $EXEC_ROOT/java/myapp/myapp
  --arg1
  --arg2

bazel run は、Bazel によってビルドされたバイナリを直接呼び出すのと類似していますが、同一ではありません。その動作は、呼び出されるバイナリがテストかどうかによって異なります。

バイナリがテストでない場合、現在の作業ディレクトリはバイナリのランファイル ツリーになります。

バイナリがテストの場合、現在の作業ディレクトリが実行ルートになり、テストが通常実行される環境の複製が試行されます。ただし、エミュレーションは完全ではなく、複数のシャードを含むテストをこの方法で実行することはできません(--test_sharding_strategy=disabled コマンドライン オプションを使用するとこの問題を回避できます)。

次の追加の環境変数もバイナリで使用できます。

  • BUILD_WORKSPACE_DIRECTORY: ビルドが実行されたワークスペースのルート。
  • BUILD_WORKING_DIRECTORY: Bazel が実行された現在の作業ディレクトリ。

たとえば、コマンドラインでファイル名をユーザー フレンドリーな方法で解釈するために使用できます。

bazel run」のオプション

--run_under=command-prefix

これは bazel test--run_under オプション(上記を参照)と同じ効果があります。ただし、これは bazel test によって実行されるテストではなく、bazel run によって実行されるコマンドに適用されるため、ラベルの下では実行できない点が異なります。

Bazel からのロギング出力のフィルタリング

bazel run でバイナリを呼び出すと、Bazel は Bazel 自体と呼び出し中のバイナリからのロギング出力を出力します。ログのノイズを軽減するには、--ui_event_filters フラグと --noshow_progress フラグを使用して、Bazel からの出力を抑制します。

例: bazel run --ui_event_filters=-info,-stdout,-stderr --noshow_progress //java/myapp:myapp

テストの実行

bazel run はテストバイナリも実行できます。これにより、テストの作成で説明されている環境とほぼ同じ環境でテストを実行できます。なお、この方法でテストを実行する場合、--test_arg 以外の --test_* 引数は効果がありません。

ビルド出力のクリーニング

clean コマンド

Bazel には、Make に似た clean コマンドがあります。 この Bazel インスタンスによって実行されたすべてのビルド構成の出力ディレクトリ、またはこの Bazel インスタンスによって作成された作業ツリー全体が削除され、内部キャッシュがリセットされます。コマンドライン オプションを指定せずに実行すると、すべての構成の出力ディレクトリがクリーンアップされます。

各 Bazel インスタンスは 1 つのワークスペースに関連付けられているため、clean コマンドを実行すると、そのワークスペースで Bazel インスタンスを使用して行ったすべてのビルドから、すべての出力が削除されます。

Bazel インスタンスによって作成された作業ツリー全体を完全に削除するには、--expunge オプションを指定します。--expunge を指定して clean コマンドを実行すると、出力ベースツリー全体が削除されます。このベースツリーには、ビルド出力に加えて、Bazel によって作成されたすべての一時ファイルが含まれます。また、クリーン後に Bazel サーバーを停止します(shutdown コマンドと同等です)。たとえば、Bazel インスタンスのすべてのディスク トレースとメモリトレースをクリーンアップするには、次のように指定します。

  % bazel clean --expunge

または、--expunge_async を使用してバックグラウンドで消去することもできます。非同期消去を実行しながら同じクライアントで Bazel コマンドを呼び出すと安全です。

clean コマンドは主に、不要になったワークスペースのディスク容量を回収する手段として提供されています。Bazel の増分再ビルドは完全ではない可能性があるため、clean を使用すると、問題が発生した場合に一貫した状態を復元できます。

Bazel は、このような問題を修正できるように設計されています。また、これらのバグは修正の優先度が高くなります。誤った増分ビルドを見つけた場合は、clean を使用せずに、ツールでバグレポートを提出してバグを報告してください。

依存関係グラフをクエリする

Bazel には、ビルド中に使用される依存関係グラフについて質問するためのクエリ言語が含まれています。クエリ言語は、query と cquery の 2 つのコマンドで使用されます。2 つのコマンドの主な違いは、クエリは読み込みフェーズの後に実行され、cquery は分析フェーズの後に実行されることです。これらのツールは、多くのソフトウェア エンジニアリング タスクで非常に役立ちます。

クエリ言語はグラフに対する代数演算の考え方に基づいています 詳細については

Bazel クエリ リファレンス。 参考のため、例、クエリ固有のコマンドライン オプションについては、このドキュメントを参照してください。

クエリツールでは、いくつかのコマンドライン オプションを使用できます。--output: 出力形式を選択します。--[no]keep_going(デフォルトで無効)を指定すると、エラー発生時にクエリツールが処理を続行します。この動作は、エラーで不完全な結果が許容されない場合は、無効になることがあります。

--[no]tool_deps オプションはデフォルトで有効になっています。ターゲット以外の構成の依存関係は、クエリが実行される依存関係グラフに含まれます。

デフォルトで有効になっている --[no]implicit_deps オプションを使用すると、クエリが実行される依存関係グラフに暗黙的な依存関係が含まれます。暗黙的な依存関係とは、BUILD ファイルで明示的に指定されていないものの、bazel によって追加された依存関係です。

例: 「PEBL ツリー内のすべてのテストをビルドするために必要なすべての genrules の定義(BUILD ファイル内)の場所を表示する」

  bazel query --output location 'kind(genrule, deps(kind(".*_test rule", foo/bar/pebl/...)))'

アクション グラフのクエリ

aquery コマンドを使用すると、ビルドグラフ内のアクションをクエリできます。分析後に構成されたターゲット グラフで動作し、アクション、アーティファクト、それらの関係に関する情報を公開します。

このツールでは、いくつかのコマンドライン オプションを使用できます。--output: 出力形式を選択します。デフォルトの出力形式(text)は人が読める形式です。機械が読み取れる形式には proto または textproto を使用します。特に、aquery コマンドは通常の Bazel ビルド上で実行され、ビルド中に使用できる一連のオプションを継承します。

従来の query で使用できるものと同じ関数セットをサポートしていますが、siblingsbuildfilestests を使用できます。

詳しくは、アクション グラフ クエリをご覧ください。

その他のコマンドとオプション

help

help コマンドは、オンライン ヘルプを表示します。デフォルトでは、Bazel を使用したビルドに示すように、使用可能なコマンドの概要とヘルプトピックが表示されます。 引数を指定すると、特定のトピックの詳細なヘルプが表示されます。ほとんどのトピックは buildquery などの Bazel コマンドですが、コマンドに対応していないヘルプトピックもあります。

--[no]long-l

デフォルトでは、bazel help [topic] はトピックの関連オプションの概要のみを出力します。--long オプションを指定すると、各オプションのタイプ、デフォルト値、詳細な説明も出力されます。

shutdown

Bazel サーバー プロセスは、shutdown コマンドを使用して停止できます。このコマンドを実行すると、Bazel サーバーがアイドル状態になるとすぐに終了します(たとえば、進行中のビルドやその他のコマンドの完了後)。詳細については、クライアント/サーバーの実装をご覧ください。

Bazel サーバーはアイドル タイムアウト後に自動的に停止するため、このコマンドが必要になることはほとんどありませんが、特定のワークスペースでそれ以上ビルドが行われないことがわかっている場合は、スクリプトで役立ちます。

shutdown--iff_heap_size_greater_than _n_ という 1 つのオプションを受け入れます。これには整数の引数(MB 単位)が必要です。指定すると、すでに使用されているメモリの量に応じてシャットダウンが行われます。これは、Bazel サーバーでメモリリークが発生すると誤ってクラッシュする可能性があるため、多数のビルドを開始するスクリプトに役立ちます。条件付き再起動を実行すると、この条件がプリエンプトされます。

info

info コマンドは、Bazel サーバー インスタンスまたは特定のビルド構成に関連付けられているさまざまな値を出力します。 (ビルドを実行するスクリプトで使用される場合があります)。

info コマンドでは、(オプションの)引数を 1 つ指定できます。これは、以下のリストにあるキーのいずれかの名前です。この場合、bazel info key はその 1 つのキーの値のみを出力します。(これは、Bazel をスクリプトで記述する場合に特に便利です。この方法を使用すると、sed -ne /key:/s/key://p で結果をパイプする必要がなくなります。

構成に依存しないデータ

  • release: この Bazel インスタンスのリリースラベル。リリース バイナリでない場合は「development version」。
  • workspace: ベース ワークスペース ディレクトリへの絶対パス。
  • install_base: 現在のユーザーに対してこの Bazel インスタンスで使用されているインストール ディレクトリの絶対パス。Bazel は、内部に必要な実行可能ファイルをこのディレクトリの下にインストールします。

  • output_base: 現在のユーザーとワークスペースの組み合わせに対してこの Bazel インスタンスで使用されるベース出力ディレクトリの絶対パス。Bazel は、すべてのスクラッチとビルドの出力をこのディレクトリに配置します。

  • execution_root: output_base の実行ルート ディレクトリへの絶対パス。このディレクトリは、ビルド中に実行されるコマンドからアクセス可能なすべてのファイルのルートであり、それらのコマンドの作業ディレクトリです。ワークスペース ディレクトリが書き込み可能な場合、このディレクトリを指す bazel-<workspace> という名前のシンボリック リンクが配置されます。

  • output_path: 実行ルートの下にある出力ディレクトリへの絶対パス。ビルドコマンドの結果として実際に生成されたすべてのファイルに使用されます。ワークスペース ディレクトリが書き込み可能な場合、このディレクトリを指す bazel-out という名前のシンボリック リンクが配置されます。

  • server_pid: Bazel サーバー プロセスのプロセス ID。

  • server_log: Bazel サーバーのデバッグ ログファイルへの絶対パス。このファイルには、Bazel サーバーの存続期間にわたるすべてのコマンドのデバッグ情報が含まれています。また、Bazel デベロッパーとパワーユーザーが使用することを想定しています。

  • command_log: コマンド ログファイルの絶対パス。これには、最新の Bazel コマンドのインターリーブされた stdout ストリームと stderr ストリームが含まれます。bazel info を実行すると、このファイルの内容が上書きされ、これが最新の Bazel コマンドになるためです。ただし、コマンド ログファイルの場所は、--output_base または --output_user_root オプションの設定を変更しない限り変更されません。

  • used-heap-sizecommitted-heap-sizemax-heap-size: さまざまな JVM ヒープサイズ パラメータをレポートします。それぞれ、現在使用されているメモリ、システムから JVM が使用できることが現在保証されているメモリ、可能な最大割り当てです。

  • gc-countgc-time: この Bazel サーバーの起動以降のガベージ コレクションの累積数と実行にかかった時間。これらの値は、すべてのビルドの開始時にリセットされるわけではないことに注意してください。

  • package_path: bazel でパッケージを検索するパスをコロンで区切ったリスト。--package_path ビルド コマンドライン引数と同じ形式です。

例: Bazel サーバーのプロセス ID。

% bazel info server_pid
1285

構成固有のデータ

これらのデータは、bazel info に渡される構成オプション(--cpu--compilation_mode など)の影響を受ける場合があります。info コマンドは、依存関係分析を制御するすべてのオプションを受け入れます。これらのオプションによっては、ビルドの出力ディレクトリの場所やコンパイラの選択などが決まるからです。

  • bazel-binbazel-testlogsbazel-genfiles: ビルドによって生成されたプログラムが存在する bazel-* ディレクトリへの絶対パスを報告します。これは常にではありませんが、ビルドが成功した後にベース ワークスペース ディレクトリに作成された bazel-* シンボリック リンクと同じです。ただし、ワークスペース ディレクトリが読み取り専用の場合、bazel-* シンボリック リンクは作成できません。シンボリック リンクの存在を前提とするのではなく、bazel info によって報告された値を使用するスクリプトは、より堅牢になります。
  • 完全な「Make」環境--show_make_env フラグを指定すると、現在の構成の「Make」環境内のすべての変数(CCGLIBC_VERSION など)も表示されます。これらは、BUILD ファイル内で $(CC) 構文または varref("CC") 構文を使用してアクセスされる変数です。

例: 現在の構成の C++ コンパイラ。 これは「Make」環境の $(CC) 変数であるため、--show_make_env フラグが必要です。

  % bazel info --show_make_env -c opt COMPILATION_MODE
  opt

例: 現在の構成の bazel-bin 出力ディレクトリ。なんらかの理由で bazel-bin シンボリック リンクを作成できない場合(読み取り専用ディレクトリからビルドしている場合など)でも、これは正しいことが保証されます。

% bazel info --cpu=piii bazel-bin
/var/tmp/_bazel_johndoe/fbd0e8a34f61ce5d491e3da69d959fe6/execroot/io_bazel/bazel-out/piii-opt/bin
% bazel info --cpu=k8 bazel-bin
/var/tmp/_bazel_johndoe/fbd0e8a34f61ce5d491e3da69d959fe6/execroot/io_bazel/bazel-out/k8-opt/bin

version--version

version コマンドは、ビルドされた Bazel バイナリのバージョンの詳細(ビルドされた変更リストや日付など)を出力します。これらは、最新の Bazel を使用しているかどうかの判断や、バグを報告する場合に特に役立ちます。興味深い値は次のとおりです。

  • changelist: このバージョンの Bazel がリリースされた変更リスト。
  • label: この Bazel インスタンスのリリースラベル。リリース バイナリでない場合は「development version」。バグの報告に非常に役立ちます。

bazel --version は、他の引数がない場合、bazel version --gnu_format と同じ出力を出力しますが、Bazel サーバーの起動やサーバー アーカイブの展開による副作用はありません。bazel --version は任意の場所から実行できます。ワークスペース ディレクトリは必要ありません。

mobile-install

mobile-install コマンドは、アプリをモバイル デバイスにインストールします。現在サポートされているのは、ART を実行している Android デバイスのみです。

詳しくは、bazel のモバイル インストールをご覧ください。

次のオプションがサポートされています。

--incremental

設定すると、Bazel はアプリを段階的にインストールしようとします。つまり、前回のビルド以降に変更された部分だけをインストールしようとします。これにより、AndroidManifest.xml から参照されているリソース、ネイティブ コード、Java リソース(Class.getResource() によって参照されるリソースなど)は更新できません。これらが変更される場合は、このオプションを省略する必要があります。Bazel の精神に反し、Android プラットフォームの制限により、このコマンドで十分かどうか、フルインストールが必要なタイミングを知ることはユーザーの責任です。

Marshmallow 以降のデバイスを使用している場合は、--split_apks フラグを検討してください。

--split_apks

分割 APK を使用してアプリのインストールと更新をデバイス上で行うかどうかを指定します。Marshmallow 以降を搭載したデバイスでのみ動作します。--split_apks を使用する場合、--incremental フラグは必要ありません。

--start_app

インストール後にクリーンな状態でアプリを起動します。--start=COLD と同じです。

--debug_app

デバッガがアタッチされるまで待ってから、インストール後にクリーンな状態でアプリを起動します。--start=DEBUG と同じです。

--start=_start_type_

インストール後のアプリを起動する方法。サポートされる _start_type_ は次のとおりです。

  • NO アプリは起動しません。これがデフォルトの設定です。
  • COLD インストール後にクリーンな状態からアプリを起動します。
  • WARM: 増分インストール時にアプリケーションの状態を保持し、復元します。
  • DEBUG - インストール後、デバッガがクリーンな状態でアプリを起動します。

--adb=path

使用する adb バイナリを示します。

デフォルトでは、--android_sdk で指定された Android SDK の adb を使用します。

--adb_arg=serial

adb に追加の引数。これらはコマンドラインのサブコマンドの前に配置され、通常はインストール先のデバイスを指定するために使用されます。 たとえば、使用する Android デバイスまたはエミュレータを選択するには、次のようにします。

% bazel mobile-install --adb_arg=-s --adb_arg=deadbeef

adb を次のように呼び出します。

adb -s deadbeef install ...

--incremental_install_verbosity=number

増分インストールの詳細度。1 に設定すると、デバッグ ロギングがコンソールに出力されます。

dump

dump コマンドは、Bazel サーバーの内部状態のダンプを stdout に出力します。このコマンドは主に Bazel デベロッパーによる使用を目的としているため、このコマンドの出力は指定されておらず、変更される可能性があります。

デフォルトでは、Bazel の状態の特定の領域をダンプするオプションの概要を示すヘルプ メッセージが出力されます。内部状態をダンプするには、少なくとも 1 つのオプションを指定する必要があります。

次のオプションがサポートされています。

  • --action_cache は、アクション キャッシュのコンテンツをダンプします。
  • --packages はパッケージ キャッシュのコンテンツをダンプします。
  • --skyframe は内部 Bazel 依存関係グラフの状態をダンプします。
  • --rules は、数やアクション数など、各ルールとアスペクト クラスのルールの概要をダンプします。これには、ネイティブ ルールと Starlark ルールの両方が含まれます。メモリ トラッキングが有効になっている場合は、ルールのメモリ消費量も出力されます。
  • --skylark_memory は、指定されたパスに pprof 互換の .gz ファイルをダンプします。そのためには、メモリ トラッキングを有効にする必要があります。

メモリのトラッキング

一部の dump コマンドには、メモリ トラッキングが必要です。これを有効にするには、起動フラグを Bazel に渡す必要があります。

  • --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar
  • --host_jvm_args=-DRULE_MEMORY_TRACKER=1

java-agent は third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar で Bazel にチェックインされるため、Bazel リポジトリを保持する場所に合わせて $BAZEL を調整してください。

コマンドごとに、必ずこれらのオプションを Bazel に渡してください。そうしないと、サーバーが再起動します。

例:

    % bazel --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
    --host_jvm_args=-DRULE_MEMORY_TRACKER=1 \
    build --nobuild <targets>

    # Dump rules
    % bazel --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
    --host_jvm_args=-DRULE_MEMORY_TRACKER=1 \
    dump --rules

    # Dump Starlark heap and analyze it with pprof
    % bazel --host_jvm_args=-javaagent:$BAZEL/third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar \
    --host_jvm_args=-DRULE_MEMORY_TRACKER=1 \
    dump --skylark_memory=$HOME/prof.gz
    % pprof -flame $HOME/prof.gz

analyze-profile

analyze-profile コマンドは、Bazel の呼び出し中に収集された JSON トレース プロファイルを分析します。

canonicalize-flags

canonicalize-flags コマンド。Bazel コマンドのオプションのリストを取得し、同じ効果を持つオプションのリストを返します。新しいオプションのリストは正規版です。たとえば、同じ効果を持つ 2 つのオプション リストは同じ新しいリストに正規化されます。

--for_command オプションを使用すると、さまざまなコマンドから選択できます。現時点では、buildtest のみがサポートされています。指定したコマンドでサポートされていないオプションは、エラーになります。

例は次のとおりです。

  % bazel canonicalize-flags -- --config=any_name --test_tag_filters="-lint"
  --config=any_name
  --test_tag_filters=-lint

起動オプション

このセクションで説明するオプションは、Bazel サーバー プロセスで使用される Java 仮想マシンの起動に影響し、そのサーバーで処理される後続のすべてのコマンドに適用されます。すでに実行中の Bazel サーバーがあり、起動オプションが一致しない場合は、サーバーが再起動されます。

このセクションで説明するオプションはすべて、--key=value 構文または --key value 構文で指定する必要があります。また、これらのオプションは、Bazel コマンド名の前に配置する必要があります。startup --key=value を使用して、これらを .bazelrc ファイルにリストします。

--output_base=dir

このオプションには path 引数が必要です。この引数には、書き込み可能なディレクトリを指定する必要があります。Bazel は、この場所を使用してすべての出力を書き込みます。出力ベースは、クライアントが Bazel サーバーを見つける際に使用する鍵でもあります。出力ベースを変更することで、コマンドを処理するサーバーを変更します。

デフォルトでは、出力ベースはユーザーのログイン名とワークスペース ディレクトリの名前(実際には MD5 ダイジェスト)から取得されます。そのため、一般的な値は /var/tmp/google/_bazel_johndoe/d41d8cd98f00b204e9800998ecf8427e のようになります。

次に例を示します。

 OUTPUT_BASE=/var/tmp/google/_bazel_johndoe/custom_output_base
% bazel --output_base ${OUTPUT_BASE}1 build //foo  &  bazel --output_base ${OUTPUT_BASE}2 build //bar

このコマンドでは、(シェルの &amp; 演算子により)2 つの Bazel コマンドが同時に実行され、それぞれが異なる Bazel サーバー インスタンスを使用します(出力ベースが異なるため)。一方、デフォルトの出力ベースが両方のコマンドで使用されていた場合、両方のリクエストが同じサーバーに送信され、そこで順次処理されます。つまり、最初に //foo をビルドし、次に //bar の増分ビルドが続きます。

--output_user_root=dir

出力ベースとインストール ベースが作成されるルート ディレクトリを指します。ディレクトリが存在しないか、呼び出し元のユーザーによって所有されている必要があります。これまでは、さまざまなユーザー間で共有されるディレクトリを指すことが可能でしたが、現在は使用できません。これは、問題 #11100 に対処すれば許可される可能性があります。

--output_base オプションを指定すると、--output_user_root を使用した出力ベースの計算がオーバーライドされます。

インストール ベースの場所は、--output_user_root と、Bazel 埋め込みバイナリの MD5 ID に基づいて計算されます。

ファイル システム レイアウトに適切な場所がある場合は、--output_user_root オプションを使用して Bazel のすべての出力(インストール ベースと出力ベース)に代替のベース ロケーションを選択できます。

--server_javabase=dir

Bazel 自体が実行される Java 仮想マシンを指定します。値には、JDK または JRE を含むディレクトリへのパスを指定する必要があります。ラベルは使用できません。 このオプションは、Bazel コマンドの前に表示されます。次に例を示します。

  % bazel --server_javabase=/usr/local/buildtools/java/jdk11 build //foo

このフラグは、アプリケーション、テスト、ツールなど、Bazel サブプロセスで使用される JVM には影響しません。代わりに、ビルド オプションの --javabase または --host_javabase を使用してください。

このフラグは以前は --host_javabase(左側の --host_javabase)という名前でしたが、ビルドフラグ --host_javabase(「右側」の --host_javabase)との混同を避けるために名前が変更されました。

--host_jvm_args=string

Bazel 自体が実行される Java 仮想マシンに渡す起動オプションを指定します。これはスタックサイズの設定に使用できます。次に例を示します。

  % bazel --host_jvm_args="-Xss256K" build //foo

このオプションは、個々の引数で複数回使用できます。このフラグの設定が必要になることはほとんどありません。スペース区切りの文字列リストを渡すこともできます。この場合、それぞれが個別の JVM 引数として解釈されますが、この機能はまもなく非推奨になります。

Bazel のサブプロセスで使用される JVM(アプリケーション、テスト、ツールなど)に影響がないこと。JVM オプションを bazel run とコマンドラインのどちらで実行するかに関係なく、実行可能な Java プログラムに渡すには、すべての java_binary プログラムと java_test プログラムがサポートする --jvm_flags 引数を使用する必要があります。代わりに、テストには bazel test --test_arg=--jvm_flags=foo ... を使用します。

--host_jvm_debug

このオプションを使用すると、Java 仮想マシンは JDWP 準拠のデバッガからの接続を待機してから、Bazel 自体のメインメソッドを呼び出します。これは、主に Bazel デベロッパーによる使用を目的としています。

--autodetect_server_javabase

このオプションを使用すると、Bazel は起動時にインストールされている JDK を自動的に検索します。埋め込み JRE が使用できない場合は、インストールされている JRE にフォールバックします。--explicit_server_javabase を使用すると、Bazel の実行に使用する明示的な JRE を選択できます。

--batch

バッチモードでは、Bazel は標準のクライアント/サーバー モードを使用せず、代わりに 1 つのコマンドに対して bazel Java プロセスを実行します。これは、シグナル処理、ジョブ制御、環境変数の継承に関して予測可能なセマンティクスに使用され、chroot jail で bazel を実行するために必要です。

バッチモードでは、同じ output_base 内で適切なキューイング セマンティクスが保持されます。つまり、同時呼び出しは重複することなく順番に処理されます。サーバーが稼働しているクライアントでバッチモードの Bazel が実行されている場合、コマンドを処理する前に、まずサーバーを強制終了します。

バッチモードまたは上記の代替方法を使用すると、Bazel の動作が遅くなります。 特に、ビルドファイルのキャッシュはメモリに常駐し、連続したバッチ呼び出し間では保持されないためです。したがって、連続ビルドなど、パフォーマンスがそれほど重要でない場合は、バッチモードを使用するほうが適切な場合がよくあります。

--max_idle_secs=n

このオプションでは、最後のクライアント リクエストから終了までに、Bazel サーバー プロセスが待機する時間を秒単位で指定します。デフォルト値は 10,800(3 時間)です。--max_idle_secs=0 を指定すると、Bazel サーバー プロセスが無期限に維持されます。

このオプションは、Bazel を呼び出すスクリプトで使用され、Bazel サーバー プロセスがユーザーのマシンに残らないようにします。たとえば、presubmit スクリプトで bazel query を呼び出して、ユーザーの保留中の変更によって不要な依存関係が発生しないようにすることができます。ただし、ユーザーがそのワークスペースで最近ビルドを行っていない場合は、その日が終わるまで Bazel サーバーを起動しないまま presubmit スクリプトを起動することは望ましくありません。クエリ リクエストで --max_idle_secs の小さな値を指定すると、スクリプトによって新しいサーバーが起動ifされた場合、そのサーバーはすぐに終了しますが、サーバーがすでに実行中の場合は、そのサーバーが通常の時間アイドル状態になるまで実行され続けます。既存のサーバーのアイドル タイマーはリセットされます。

--[no]shutdown_on_low_sys_mem

有効で、--max_idle_secs が正の期間に設定されている場合、ビルドサーバーがしばらくアイドル状態になってから、システムのメモリ残量が少なくなったらサーバーをシャットダウンします。Linux のみ。

ビルドサーバーは、max_idle_secs に対応するアイドル チェックを実行するだけでなく、サーバーがしばらくアイドル状態になると、使用可能なシステムメモリのモニタリングを開始します。使用可能なシステムメモリが非常に少なくなると、サーバーは終了します。

--[no]block_for_lock

有効にすると、Bazel はサーバーロックを保持している他の Bazel コマンドが完了するまで待ってから処理を進めます。無効にすると、Bazel がロックをすぐに取得できず、処理を続行できないと、エラーで終了します。

デベロッパーは、presubmit チェックでこれを使用して、同じクライアント内の別の Bazel コマンドによる長い待機を回避することができます。

--io_nice_level=n

ベスト エフォートの IO スケジューリングのレベルを 0 ~ 7 に設定します。0 は最も高い優先度、7 は最も低い優先度です。予測型スケジューラは優先度 4 までしか尊重できません。 負の値は無視されます。

--batch_cpu_scheduling

Bazel で batch CPU スケジューリングを使用します。このポリシーは、インタラクティブではないものの、見栄えのよい値を下げたくないワークロードに役立ちます。「man 2 sched_setscheduler」を参照してください。このポリシーにより、Bazel のスループットを犠牲にして、システムのインタラクティブ性が向上する場合があります。

その他のオプション

--[no]announce_rc

起動時に bazelrc ファイルから読み取ったコマンド オプションを Bazel が通知するかどうかを制御します。(起動オプションは無条件に通知されます)。

--color (yes|no|auto)

このオプションは、Bazel で色を使用して画面上の出力をハイライト表示するかどうかを決定します。

このオプションを yes に設定すると、色出力が有効になります。 このオプションを auto に設定すると、出力がターミナルに送信され、TERM 環境変数が dumbemacsxterm-mono 以外の値に設定されている場合にのみ、Bazel はカラー出力を使用します。このオプションを no に設定すると、出力がターミナルに向かうかどうかや、TERM 環境変数の設定に関係なく、カラー出力が無効になります。

--config=name

RC ファイルから追加の構成セクションを選択します。現在の command については、そのようなセクションが存在する場合は command:name からオプションも取得します。複数回指定して、複数の構成セクションからフラグを追加できます。展開は他の定義を参照できます(たとえば、展開を連結できます)。

--curses (yes|no|auto)

このオプションは、Bazel が画面出力でカーソル コントロールを使用するかどうかを決定します。これにより、スクロールするデータが少なくなり、Bazel からの出力ストリームがコンパクトになり、読みやすくなります。これは --color とうまく連携します。

このオプションを yes に設定すると、カーソル コントロールの使用が有効になります。このオプションを no に設定すると、カーソル コントロールが無効になります。このオプションを auto に設定すると、--color=auto と同じ条件でカーソル コントロールが有効になります。

--[no]show_timestamps

指定すると、Bazel によって生成された各メッセージにタイムスタンプが追加され、メッセージが表示された時刻が指定されます。