このページでは、bazel build
、bazel run
、bazel test
などのさまざまな Bazel コマンドで使用できるオプションについて説明します。このページは、Bazel を使用したビルドの Bazel コマンドのリストに対応するものです。
ターゲットの構文
build
や test
などの一部のコマンドは、ターゲットのリストを操作できます。Google
ラベルよりも柔軟な構文を使用します。これについては、
ビルドするターゲットの指定。
オプション
以降のセクションでは、ビルド時に使用できるオプションについて説明します。--long
をヘルプコマンドで使用すると、オンライン ヘルプ メッセージに、各オプションの意味、タイプ、デフォルト値に関する概要情報が表示されます。
ほとんどのオプションは 1 回しか指定できません。複数回指定すると、 最後のインスタンスが優先します複数回指定できるオプションは、オンライン ヘルプで「複数回使用可能」というテキストで示されています。
パッケージの場所
--package_path
警告: --package_path
オプションは非推奨になりました。Bazel はパッケージを優先
ワークスペースのルートの下に配置します。
このオプションは、検索対象のディレクトリのセットを 特定のパッケージの BUILD ファイルを見つけます。
Bazel は、パッケージパスを検索してパッケージを見つけます。これはコロンです 順番に並んだ bazel ディレクトリの順付きリストで、それぞれが 部分的なソースツリーです。
--package_path
オプションを使用してカスタム パッケージ パスを指定するには:
% bazel build --package_path %workspace%:/some/other/root
パッケージ パス要素は、次の 3 つの形式で指定できます。
- 最初の文字が
/
の場合、パスは絶対パスです。 - パスが
%workspace%
で始まる場合、相対パスが使用されます。 最も近い bazel ディレクトリに移動します。 たとえば、作業ディレクトリが/home/bob/clients/bob_client/bazel/foo
の場合、package-path の文字列%workspace%
は/home/bob/clients/bob_client/bazel
に展開されます。 - それ以外は、作業ディレクトリを基準とする相対パスになります。
通常これは意図した動作ではなく
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 MODULE.bazel % 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++、Java、Python の前処理、コンパイル、アセンブルを 記述できます。リンク時には渡されません。
このオプションは複数回使用できます。例:
% bazel build --copt="-g0" --copt="-fpic" //foo
デバッグ テーブルなしで foo
ライブラリをコンパイルし、
使用できます。
--host_copt=cc-option
このオプションは、ソースファイルのコンパイラに渡す引数を受け取ります。
実行構成ファイル内にコンパイルされます。これは --copt
オプションに似ていますが、exec 構成にのみ適用されます。
--host_conlyopt=cc-option
このオプションは、exec 構成でコンパイルされる C ソースファイルのコンパイラに渡す引数を受け取ります。これは --conlyopt
オプションに似ていますが、exec 構成にのみ適用されます。
--host_cxxopt=cc-option
このオプションは、exec 構成でコンパイルされる C++ ソースファイルのコンパイラに渡す引数を受け取ります。これは --cxxopt
オプションに似ていますが、exec 構成にのみ適用されます。
--host_linkopt=linker-option
このオプションは、exec 構成でコンパイルされたソースファイルのリンカーに渡される引数を受け取ります。これは
--linkopt
オプション。ただし、このオプションは
変更します。
--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
オプションを指定してリンカーを呼び出すことで、すべてのバイナリと共有ライブラリからデバッグ情報を削除するかどうかを指定します。--strip=always
は、デバッグ情報を常に削除することを意味します。--strip=never
は、デバッグ情報を削除しないことを意味します。
デフォルト値の --strip=sometimes
は、--compilation_mode
が fastbuild
の場合に削除することを意味します。
% 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 ファイルのオブジェクトごとのファイル ディレクトリ ツリーのディレクトリ接頭辞として使用されます。
プロファイル データツリーが生成されたら、プロファイル ツリーを ZIP 圧縮し、--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 を指す必要がある llvm-profdata ツールによって準備されたプロファイル出力ファイル。.profdata が あります。
--fdo_instrument
オプションと --fdo_optimize
オプションを同時に使用することはできません。
--java_language_version=version
このオプションでは、Java ソースのバージョンを指定します。例:
% bazel build --java_language_version=8 java/com/example/common/foo:all
コンパイルし、Java 8 仕様と互換性のあるコンストラクトのみを許可します。デフォルト値は 11 です。-->
有効な値は 8、9、10、11、17、21 で、
default_java_toolchain
を使用したカスタム Java ツールチェーンの登録。
--tool_java_language_version=version
ビルド中で実行されるツールのビルドに使用する Java 言語バージョン。 デフォルト値は 11 です。
--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_jdk
、local_jdk_version
、
remotejdk_11
、remotejdk_17
、remotejdk_21
値を拡張するには、次のいずれかの方法を使用してカスタム JVM を登録し、
local_java_repository
または remote_java_repository
リポジトリ ルール。
--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
サーバー VM を使用してすべての Java バイナリを起動し、 VM の起動ヒープサイズを 256 MB に引き上げます。
--javacopt=javac-option
このオプションを使用すると、オプション引数を javac に渡すことができます。使用可能な 複数の引数を指定して実行することもできます。例:
% bazel build --javacopt="-g:source,lines" //myprojects:prog
javac のデフォルトのデバッグ情報で java_binary が再ビルドされる (Bazel デフォルトを使用しません)。
このオプションは、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 が次の標準 Java 警告を生成することを意味します。 欠落している直接依存関係ごとに[strict]
と入力します。default
、strict
、error
はすべて、javac が警告ではなくエラーを生成することを意味します。不足している直接依存関係が見つかった場合、現在のターゲットのビルドが失敗します。これは、フラグが指定されていない場合のデフォルトの動作でもあります。
セマンティクスを構築する
これらのオプションは、ビルドコマンドや出力ファイルの内容に影響します。
--compilation_mode (fastbuild|opt|dbg)
(-c)
--compilation_mode
オプション(多くの場合、-c
と短縮され、
特に -c opt
など)は、fastbuild
、dbg
の引数を取ります。
または opt
であり、さまざまな C/C++ コード生成に影響します。
最適化のレベルや完成度などのオプションを
デバッグ テーブルBazel はコンパイルモードごとに異なる出力ディレクトリを使用するため、毎回完全な再ビルドを行うことなくモードを切り替えることができます。
fastbuild
は、できるだけ速くビルドすることを意味します。最小限のデバッグ情報(-gmlt -Wl,-S
)を生成し、最適化は行いません。これがデフォルトです。注:-DNDEBUG
は設定されません。dbg
は、デバッグを有効にしてビルドすることを意味します(-g
)。これにより、gdb(または別のデバッガ)を使用できます。opt
は最適化を有効にしてビルドすることを意味します。assert()
件の通話が無効(-O2 -DNDEBUG
)opt
モードではデバッグ情報は生成されません ただし、--copt -g
も渡す場合は除きます。
--cpu=cpu
このオプションでは、使用するターゲット CPU アーキテクチャを指定します。 バイナリのコンパイルに役立ちます。
--action_env=VAR=VALUE
すべてのアクションの実行中に使用できる環境変数のセットを指定します。
変数は名前で指定できます。この場合、値は呼び出し環境から取得されます。また、name=value
ペアで指定することもできます。この場合、値は呼び出し環境から独立して設定されます。
この --action_env
フラグは複数回指定できます。複数の --action_env
フラグで同じ変数に値が割り当てられている場合、最後の割り当てが優先されます。
--experimental_action_listener=label
experimental_action_listener
オプションは、Bazel に対して
label で指定された action_listener
ルールから、
ビルドグラフに extra_actions
を挿入します。
--[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
ルールの伝播 deps
に cc_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
)。
実行パスは、ベース名を含むワークスペース ディレクトリへの相対パスです。 (拡張子を含む)を指定します。また、プラットフォーム固有の接頭辞も含まれます。
生成されたファイル(genrule 出力など)との照合
Bazel では実行パスのみを使用できます。この場合、正規表現は実行パスと一致しないため、「//」で始まってはいけません。パッケージ名は次のように使用できます。
--per_file_copt=base/.*\.pb\.cc@-g0
。これはすべての
.pb.cc
ファイルは base
というディレクトリにあります。
このオプションは複数回使用できます。
このオプションは、使用するコンパイル モードに関係なく適用されます。たとえば
--compilation_mode=opt
でコンパイルし、一部を選択してコンパイルする
[より強力な最適化] がオンか、または [オフ] に設定されているファイルを表示することもできます。
注意: 一部のファイルがデバッグ シンボルで選択的にコンパイルされている場合、リンク時にシンボルが削除されることがあります。これは --strip=never
を設定することで防ぐことができます。
構文: [+-]regex[,[+-]regex]...@option[,option]...
。ここで、regex
は正規表現を表します。この正規表現の前に +
を追加すると、含めるパターンを識別できます。-
を追加すると、除外するパターンを識別できます。option
は、C++ コンパイラに渡される任意のオプションを表します。オプションに ,
が含まれている場合は、\,
のように引用符で囲む必要があります。Options に @
を含めることもできます。これは最初の要素のみであるため、
@
は、正規表現とオプションを区切るために使用します。
例: --per_file_copt=//foo:.*\.cc,-//foo:file\.cc@-O0,-fprofile-arcs
は、file.cc
を除く //foo/
内のすべての .cc
ファイルに対して、C++ コンパイラのコマンドラインに -O0
オプションと -fprofile-arcs
オプションを追加します。
--dynamic_mode=mode
ビルドルールの linkstatic 属性と連携して、C++ バイナリを動的にリンクするかどうかを決定します。
モード:
default
: 動的にリンクするかどうかを Bazel で選択できるようにします。詳細については、linkstatic をご覧ください。fully
: すべてのターゲットを動的にリンクします。これにより、リンク時間が短縮され、生成されるバイナリのサイズが小さくなります。off
: すべてのターゲットをほとんど静的モードでリンクします。-static
が linkopt に設定されている場合、ターゲットは完全に静的に変更されます。
--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 ファイルの linkopts の -static
オプションは無視されます。これは単に
C++ 強化ビルドの回避策について説明します。
--[no]force_pic
有効にすると、すべての C++ コンパイルで位置独立コード(「-fPIC」)が生成されます。 リンクでは非 PIC ライブラリよりも PIC ビルド済みライブラリが優先され、リンクは 位置独立実行可能ファイル("-pie")には、デフォルトは無効になっています。
--android_resource_shrinking
android_binary ルールに対してリソース圧縮を実行するかどうかを選択します。デフォルトの shrink_resources 属性(オン) android_binary ルールそのルールのドキュメントをご覧くださいデフォルトはオフです。
--custom_malloc=malloc-library-target
指定した場合は、常に指定された malloc 実装を使用し、すべての malloc="target"
属性をオーバーライドします(malloc
を指定しないでデフォルトを使用するターゲットを含む)。
--crosstool_top=label
このオプションは、クロスツール コンパイラ スイートの場所を指定します
ビルド時のすべての C++ コンパイルに使用できます。Bazel は、その場所で CROSSTOOL ファイルを検索し、それを --compiler
の設定を自動的に決定するために使用します。
--host_crosstool_top=label
指定しない場合、Bazel は --crosstool_top
の値を使用して、ビルド中に実行されるツールなど、exec 構成内のコードをコンパイルします。このフラグの主な目的は、クロスコンパイルを有効にすることです。
--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
NOP。下位互換性のためだけに保持されています。
--host_java_toolchain=label
NoOps。下位互換性のためにのみ保持されます。
--javabase=(label)
NoOps。下位互換性のためにのみ保持されます。
--host_javabase=label
NoOps。下位互換性のためにのみ保持されます。
実行戦略
これらのオプションは、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
「Compiling //foo/bar/baz」を実行sandboxed
戦略ですが、逆方向です。 注文ではlocal
を使用して実行されます。 - 例:
--strategy_regexp='Compiling.*/bar=local,sandboxed'
実行 'コンパイル //foo/bar/baz'local
戦略と一致し 失敗した場合はsandboxed
。
--genrule_strategy=strategy
これは非推奨の --strategy=Genrule=strategy
の省略形です。
--jobs=n
(-j)
このオプションは整数引数を取り、ビルドの実行フェーズ中に同時に実行するジョブの数の上限を指定します。
--progress_report_interval=n
Bazel は、まだ完了していないジョブ(長時間実行テストなど)の進行状況レポートを定期的に出力します。このオプションでは
報告頻度。進捗は n
ごとに印刷されます。
秒です。
デフォルトは 0 で、つまり増分アルゴリズムです。 10 秒後、30 秒後に印刷されます。 進行状況が 1 分ごとに報告されます。
Bazel がカーソル コントロールを使用している場合
--curses
。進行状況は 1 秒ごとに報告されます。
--local_{ram,cpu}_resources resources or resource expression
これらのオプションでは、ローカルで実行するビルド アクティビティとテスト アクティビティのスケジュール設定時に Bazel が考慮できるローカル リソースの量(RAM(MB)と CPU 論理コア数)を指定します。整数またはキーワード(HOST_RAM または HOST_CPUS)を指定します。必要に応じて、[-|*
浮動小数点数]
(--local_cpu_resources=2
、--local_ram_resources=HOST_RAM*.5
、--local_cpu_resources=HOST_CPUS-1
など)を指定します。フラグは独立しており、1 つまたは両方を設定できます。デフォルトでは、Bazel はローカル システムの構成から RAM の量と CPU コア数を直接推定します。
--[no]build_runfile_links
このオプションはデフォルトで有効になっています。テストとバイナリの runfile シンボリック リンクを出力ディレクトリにビルドするかどうかを指定します。--nobuild_runfile_links
を使用すると、
オーバーヘッドを発生させることなくすべてのターゲットをコンパイルできるかどうかを検証
runfile ツリーを構築します。
テスト(またはアプリケーション)が実行されると、そのランタイム データの依存関係が 1 か所に集められます。Bazel の
出力ツリーの「runfiles」は、通常、ノードの兄弟ノードとして
対応するバイナリまたはテストです
テスト実行中に、$TEST_SRCDIR/canonical_repo_name/packagename/filename
形式のパスで実行ファイルにアクセスできます。runfiles ツリーにより、テストは宣言された依存関係を持つすべてのファイルにアクセスできます。デフォルトでは、必要なファイルへのシンボリック リンクのセットを構築することで、runfiles ツリーが実装されます。リンクセットの増加に伴い、このオペレーションのコストも増加します。特に、個々のテスト(またはアプリケーション)に独自の runfiles ツリーが必要なため、大規模なビルドでは全体的なビルド時間に大きく影響する可能性があります。
--[no]build_runfile_manifests
このオプションはデフォルトで有効になっており、ランファイル マニフェストを出力ツリーに書き込むかどうかを指定します。無効にすると、--nobuild_runfile_links
を指定したことになります。
ランファイル ツリーはインメモリ マニフェストからリモートで作成されるため、テストをリモートで実行する場合は、このオプションを無効にできます。
--[no]discard_analysis_cache
このオプションを有効にすると、Bazel は実行の開始直前に分析キャッシュを破棄します。これにより、実行フェーズに追加のメモリ(約 10%)が解放されます。欠点は、その後の増分ビルドが遅くなることです。関連項目 メモリ節約モード。
--[no]keep_going
(-k)
GNU Make と同様に、ビルドの実行フェーズは、最初の エラーが発生する。エラーが発生しても、できるだけ多くのビルドを試してみると役に立つことがあります。このオプションにより 指定されると、ビルドは実行を試行します。 前提条件が正常にビルドされたターゲットがすべてビルドされますが、 エラーが無視されます。
このオプションは通常、ビルドの実行フェーズに関連付けられますが、分析フェーズにも影響します。ビルドコマンドで複数のターゲットが指定されていて、そのうちの一部のみが正常に分析された場合、--keep_going
が指定されていない限り、ビルドはエラーで停止します。この場合、ビルドは正常に分析されたターゲットに対してのみ実行フェーズに進みます。
--[no]use_ijars
このオプションは、java_library
ターゲットの方法を変更します。
Bazel でコンパイルされます。Bazel は、java_library
の出力を依存する java_library
ターゲットのコンパイルに使用する代わりに、非プライベート メンバー(パブリック、保護、デフォルト(パッケージ)アクセス メソッドとフィールド)のシグネチャのみを含むインターフェース jar を作成し、インターフェース jar を使用して依存ターゲットをコンパイルします。これにより、
リソースにのみ変更が加えられた場合には、再コンパイルを
クラスのプライベート メンバーを指定できます。
--[no]interface_shared_objects
このオプションを使用すると、インターフェース共有オブジェクトが有効になり、バイナリとオブジェクトが作成されます。 他の共有ライブラリは、共有オブジェクトのインターフェースに依存します。 理解することが重要です。実装のみが変更された場合、Bazel は変更された共有ライブラリに依存するターゲットを不必要に再ビルドしないようにできます。
出力の選択
これらのオプションにより、ビルドまたはテストする対象が決まります。
--[no]build
このオプションを使用すると、ビルドの実行フェーズが実行されます。デフォルトでオンになっています。これをオフにすると、実行フェーズは スキップされ、最初の 2 つのフェーズ(読み込みと分析)だけが発生します。
このオプションは、実際にビルドせずに BUILD ファイルを検証し、入力のエラーを検出する場合に便利です。
--[no]build_tests_only
指定した場合、Bazel は *_test
の実行に必要なものだけをビルドします
と test_suite
個のルールが、
size、
timeout、
タグ、または
language。
指定すると、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]*
指定すると、Bazel は指定されたサイズのテストターゲットのみをテストします(--build_tests_only
も指定されている場合はビルドします)。テストサイズ フィルタは、使用可能なテストサイズ値(small、medium、large、enormous)をカンマ区切りで指定します。必要に応じて、除外するテストサイズを示すために「-」記号を先頭に追加します。次に例を示します。
% bazel test --test_size_filters=small,medium //foo:all
と
% bazel test --test_size_filters=-large,-enormous //foo:all
は、//foo 内の小規模テストと中規模テストのみをテストします。
デフォルトでは、テストサイズ フィルタリングは適用されません。
--test_timeout_filters=timeout[,timeout]*
指定すると、Bazel は指定されたタイムアウトでテストターゲットのみをテストします(--build_tests_only
も指定されている場合はビルドします)。テスト タイムアウト フィルタ
許可されるテスト タイムアウト値(短い、
「-」で始まる記号の意味は、
除外されたテスト タイムアウトの数です。--test_size_filters を参照
例を示します。
デフォルトでは、テストのタイムアウト フィルタリングは適用されません。
--test_tag_filters=tag[,tag]*
指定すると、Bazel がテスト(--build_tests_only
の場合はビルド)します
も指定されている場合)は、必須のタグが 1 つ以上あるテスト ターゲットのみ
(いずれかが指定されていれば)含まれており、除外されているタグはありません。テストタグ
フィルタは、タグキーワードのカンマ区切りリストとして指定します。
先頭に「-」記号を使用します。必須のタグには「+」記号が付いていることもあります。
次に例を示します。
% 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 の特定の解釈は、
テスト フレームワークです。グロブ、サブ文字列、正規表現にすることができます。--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 つの
ビルド ターゲットを指定すると、Bazel は、
ターゲットが最新に正常に更新されているかどうか、
ターゲットによって作成された出力ファイルのリスト。複数の場合
ターゲットが指定された場合、結果情報は表示されません。
結果の情報は、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 シェル互換の構文で出力されるため、コマンドを簡単にコピーしてシェル コマンド プロンプトに貼り付けることができます。(囲んでいるかっこは、cd
呼び出しと exec
呼び出しからシェルを保護するために提供されています。必ずコピーしてください)。ただし、次のような一部のコマンドは Bazel 内に内部的に実装されています。
シンボリック リンク ツリーを作成します。これらのコマンドラインは表示されません。
--subcommands=pretty_print
を print に渡すことができる
コマンドの引数を 1 行ではなくリストとして指定します。このため、
長いコマンドラインが読みやすくなります。
以下の --verbose_failures の失敗もご覧ください。
ツールに適した形式でサブコマンドをファイルにロギングするには、--execution_log_json_file と --execution_log_binary_file をご覧ください。
--verbose_failures
このオプションを使用すると、Bazel の実行フェーズで、失敗したコマンドの完全なコマンドラインが出力されます。これは、失敗したビルドのデバッグに非常に役立ちます。
失敗したコマンドは、Bourne シェル互換の構文で出力されます。これは、シェル プロンプトにコピーして貼り付けるのに適しています。
ワークスペースのステータス
これらのオプションを使用して、Bazel でビルドされたバイナリに「スタンプ」を付けます。ソース管理リビジョンやその他のワークスペース関連情報など、バイナリに追加情報を埋め込みます。次を使用:
このメカニズムには、次のような stamp
属性をサポートするルールが含まれます。
genrule
、cc_binary
など。
--workspace_status_command=program
このフラグを使用すると、Bazel が各ビルドの前に実行するバイナリを指定できます。このプログラムは、現在のソース管理リビジョンなど、ワークスペースのステータスに関する情報を報告できます。
フラグの値には、ネイティブ プログラムへのパスを指定する必要があります。Linux/macOS では、任意の実行可能ファイルを指定できます。 Windows ではネイティブ・バイナリ(通常は「.exe」、「.bat」、「.cmd」)にする必要があります。表示されます。
プログラムは、0 個以上の Key-Value ペアを標準出力に出力する必要があります(各行に 1 エントリずつ)。 その後、ゼロで終了します(そうでなければビルドは失敗します)。キー名には任意の名前を付けることができますが、 大文字とアンダースコアのみ使用できます。キー名の後の最初のスペースは、キー名と値を区切ります。値は行の残り(追加の空白文字を含む)です。鍵も 値は複数行にまたがっても構いません。キーは重複しないようにしてください。
Bazel は、キーを「安定」と「揮発性」の 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 はスタンプされたアクションを再実行します。そのため、Stable ステータスにはタイムスタンプなどを含めないでください。それらはすべて変更されるためです。 Bazel はスタンプ付きアクションをビルドごとに再実行します。Bazel は常に次の安定したキーを出力します。
BUILD_EMBED_LABEL
:--embed_label
の値BUILD_HOST
: Bazel が実行されているホストマシンの名前BUILD_USER
: Bazel が実行されているユーザーの名前
「揮発性」キーの値は頻繁に変更される可能性があります。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 では、true
は何もせず、正常に終了(ゼロで終了)し、出力も出力しないため、--workspace_status_command=/bin/true
を渡してワークスペースのステータスの取得を無効にできます。Windows では、MSYS の true.exe
のパスを渡すことができます。
同じ効果が得られます。
なんらかの理由でワークスペース ステータス コマンドが失敗する(ゼロ以外の値で終了する)と、ビルドは失敗します。
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 Encyclopedia をご覧ください。ルールで stamp = -1
(*_binary
ルールのデフォルト)が設定されている場合、このオプションによってスタンプが有効かどうかが決まります。
Bazel は、exec 構成用にビルドされたバイナリをスタンプしません。
このオプションや stamp
属性に関係なく適用されます。stamp =
0
(*_test
ルールのデフォルト)を設定するルールの場合、--[no]stamp
に関係なくスタンプは無効になります。--stamp
を指定しても、依存関係が変更されていない場合、ターゲットの再ビルドは強制されません。
--nostamp
の設定は、ビルドのパフォーマンスを向上させるため、一般的に推奨されます。
入力の変動性が低減し、ビルド キャッシュが最大化されます。
プラットフォーム
これらのオプションを使用して、ビルドの動作を構成するホストとターゲットのプラットフォームを制御し、 Bazel ルールで使用できる実行プラットフォームとツールチェーンを制御します。
--platforms=labels
ターゲットとするプラットフォームを記述するプラットフォーム ルールのラベル 確認できます。
--host_platform=label
ホストシステムを記述するプラットフォーム ルールのラベル。
--extra_execution_platforms=labels
アクションを実行する実行プラットフォームとして使用できるプラットフォーム。プラットフォームは正確なターゲットで、またはターゲット パターンとして指定できます。これらの これらのプラットフォームは、MODULE.bazel ファイルで宣言されている register_execution_platforms(). このオプションでは、優先度の高い順にプラットフォームのカンマ区切りのリストを指定できます。 フラグが複数回渡された場合は、最新のオーバーライドが適用されます。
--extra_toolchains=labels
ツールチェーンの解決時に考慮されるツールチェーン ルール。ツールチェーン 正確なターゲットで、またはターゲット パターンとして指定できます。これらの toolchain は、register_toolchains() によって MODULE.bazel ファイルで宣言された toolchain よりも前に考慮されます。
--toolchain_resolution_debug=regex
ツールチェーン タイプが一致した場合にツールチェーンを検索しながらデバッグ情報を出力
使用します。複数の正規表現をカンマで区切って指定できます。正規表現を否定するには、先頭に -
を使用します。デベロッパーにとって
ツールチェーンの欠落によるデバッグエラーがある Bazel ルールまたは Starlark ルール。
その他
--flag_alias=alias_name=target_path
長い Starlark ビルド設定を短い名前にバインドするために使用されるコンビニエンス フラグ。詳細については、Starlark 構成をご覧ください。
--symlink_prefix=string
生成されたコンビニエンス シンボリック リンクの接頭辞を変更します。「
シンボリック リンク接頭辞のデフォルト値は bazel-
で、
シンボリック リンク bazel-bin
、bazel-testlogs
、
bazel-genfiles
。
なんらかの理由でシンボリック リンクを作成できない場合は、警告が出されますが、ビルドは成功と見なされます。特に、読み取り専用ディレクトリや書き込み権限のないディレクトリをビルドできます。ビルドの終了時に情報メッセージで出力されるパスでは、シンボリック リンクが想定される場所を参照している場合にのみ、シンボリック リンク相対の短い形式が使用されます。つまり、シンボリック リンクが作成されることを信頼できない場合でも、これらのパスの正確性を信頼できます。
このオプションの一般的な値は次のとおりです。
シンボリック リンクの作成を抑制:
--symlink_prefix=/
を使用すると、Bazel はbazel-out
シンボリック リンクとbazel-<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
コマンド svg
、web
、list
を試してください。
リリースに Bazel を使用する
Bazel は、開発サイクル中のソフトウェア エンジニアと、本番環境へのデプロイ用のバイナリを準備するリリース エンジニアの両方によって使用されます。このセクションでは、Bazel を使用するリリース エンジニア向けのヒントを紹介します。
重要なオプション
リリースビルドに Bazel を使用すると、ビルドを実行する他のスクリプトと同じ問題が発生します。詳しくは、 スクリプトから Bazel を呼び出す。特に、次のオプションを強くおすすめします。
これらのオプションも重要です。
--package_path
--symlink_prefix
: 複数の構成のビルドを管理する場合は、各ビルドを個別の識別子(「64bit」と「32bit」など)で区別すると便利です。このオプションは、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」の場合、キャッシュの動作は自動と同じですが、--runs_per_test
でテストの失敗とテスト実行がキャッシュに保存される場合があります。
.bazelrc
ファイルでこのオプションをデフォルトで有効にしているユーザーは、特定の実行でデフォルトをオーバーライドする場合に、省略形の -t
(オン)または -t-
(オフ)が便利です。
--check_tests_up_to_date
このオプションは、テストを実行せず、キャッシュに保存されたテスト結果を確認して報告するように Bazel に指示します。以前にビルドおよび実行されていないテストがある場合、またはテスト結果が古い場合(ソースコードまたはビルド オプションが変更された場合など)、Bazel はエラー メッセージ(「test result is not up-to-date」)を報告し、テストのステータスを「NO STATUS」(色出力が有効になっている場合は赤色)として記録し、ゼロ以外の終了コードを返します。
このオプションは
--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 を返した場合、テストは不安定なステータスになります(他の失敗した実行が原因で失敗した場合を除きます)。
1 つの数値を指定すると、すべてのテストがその回数だけ実行されます。
または、構文を使用して正規表現を指定することもできます。
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
は、各テストの結果と名前を出力します。 テストが失敗した場合に、テスト出力を含むファイル。これがデフォルト値です。terse
はshort
と似ているが、さらに短い: 印刷のみ 不合格だったテストに関する情報が出力されます。detailed
は、各テストだけでなく、失敗した個々のテストケースを出力します。テスト出力ファイルの名前は省略します。none
はテストの概要を出力しません。
--test_output=output_style
テスト出力の表示方法を指定します。
summary
は、各テストに合格したかどうか、または合格したかどうかのサマリーを表示します。 失敗しました。失敗したテストの出力ログファイル名も示します。まとめ がビルドの最後に出力されます(ビルド中に、 テストの開始時、合格時、失敗時に進行状況を示す単純なメッセージだけを表示します。 これはデフォルトの動作です。errors
が、失敗したテストの stdout/stderr 出力を組み合わせて送信 テスト完了直後に stdout にエクスポートすることで、 同時テストのテスト出力が互いにインターリーブされません。 上記の概要出力に従って、ビルド時に概要を出力します。all
はerrors
に似ていますが、次の内容の出力を出力します: すべてのテストを記録します。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 つの値を指定し、 テストごとに個別のタイムアウトを設定できます(テストの できます。 いずれの場合も、いずれかのテストサイズでゼロまたは負の値を指定すると、 次のように、指定されたタイムアウト カテゴリのデフォルトのタイムアウトに置き換えられます。 テストの作成ページで定義されています。 デフォルトでは、Bazel はすべてのテストでこれらのタイムアウトを使用します。 テストのサイズからタイムアウト制限を推測し、 明示的に設定することもできます。
テストでは、タイムアウト カテゴリと size は、タイムアウトが暗黙的に設定されていた場合と同じ値を受け取ります。 指定します。そのため、タイムアウトを「長い」と宣言するサイズが「小さい」テストは、明示的なタイムアウトのない「大きい」テストと同じ有効なタイムアウトになります。
--test_arg=arg
コマンドライン オプション、フラグ、引数を各テストプロセスに渡します。このオプションは複数回使用して、複数の引数を渡すことができます。例: --test_arg=--logtostderr --test_arg=--v=3
なお、bazel run
コマンドとは異なり、テスト引数を渡することはできません。
bazel test -- target --logtostderr --v=3
のように直接渡されます。なぜなら、
bazel test
に渡された余分な引数は、追加のテストとして解釈されます
できます。つまり、--logtostderr
と --v=3
はそれぞれテスト対象として解釈されます。このあいまいさは、bazel run
コマンドには存在しません。
1 つのターゲットを受け入れます。
--test_arg
は bazel 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'
テストの選択
出力選択オプションで説明されているように、 テストをサイズ、 timeout、 タグ、または language。利便性 一般名フィルタでは、特定のトピックを フィルタ引数をテストランナーに渡します。
bazel test
のその他のオプション
構文と残りのオプションは bazel build
とまったく同じです。
実行可能ファイルの実行
bazel run
コマンドは bazel build
に似ていますが、単一のターゲットのビルドと実行に使用されます。一般的なセッションは次のとおりです(//java/myapp:myapp
が hello を表示し、引数を出力します)。
% bazel run java/myapp:myapp -- --arg1 --arg2 INFO: Analyzed target //java/myapp:myapp (13 packages loaded, 27 targets configured). INFO: Found 1 target... Target //java/myapp:myapp up-to-date: bazel-bin/java/myapp/myapp INFO: Elapsed time: 14.290s, Critical Path: 5.54s, ... INFO: Build completed successfully, 4 total actions INFO: Running command line: bazel-bin/java/myapp/myapp <args omitted> Hello there $EXEC_ROOT/java/myapp/myapp --arg1 --arg2
bazel run
は、Bazel によってビルドされたバイナリを直接呼び出す場合と似ていますが、同じではありません。その動作は、呼び出されるバイナリがテストかどうかによって異なります。
バイナリがテストでない場合、現在の作業ディレクトリは runfiles ツリーを使用します。
バイナリがテストの場合、現在の作業ディレクトリが exec ルート
その環境テストを再現するために 誠実な試みが
できます。ただし、エミュレーションは完全ではなく、複数の呼び出しが
シャードをこの方法で実行することはできません(
--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 自体と呼び出し中のバイナリからのロギング出力が印刷されます。ログのノイズを減らすには、--ui_event_filters
フラグと --noshow_progress
フラグを使用して Bazel 自体の出力を抑制します。
次に例を示します。bazel run --ui_event_filters=-info,-stdout,-stderr --noshow_progress //java/myapp:myapp
テストの実行
bazel run
はテスト バイナリを実行することもできます。これにより、テストの作成で説明されている環境に近い状態でテストを実行できます。なお、
この方法でテストを実行する場合、--test_*
引数は影響します。ただし、
--test_arg
です。
ビルド出力のクリーンアップ
clean
コマンド
Bazel には、Make と同様の clean
コマンドがあります。実行されたすべてのビルド構成の出力ディレクトリが削除されます。
この Bazel インスタンス、またはこの Bazel インスタンスで作成された
Bazel インスタンスを実行し、内部キャッシュをリセットします。何も指定せずに実行した場合、
すべての構成の出力ディレクトリを
削除されます。
各 Bazel インスタンスは単一のワークスペースに関連付けられているため、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 ツリー内のすべてのテストをビルドするために必要なすべての genrule の定義(BUILD ファイル内)のロケーションを表示します。」
bazel query --output location 'kind(genrule, deps(kind(".*_test rule", foo/bar/pebl/...)))'
アクショングラフのクエリ
aquery
コマンドを使用すると、ビルドグラフ内のアクションをクエリできます。
分析後に構成されたターゲット グラフで動作し、
アクション、アーティファクト、それらの関係に関する情報です。
このツールは、いくつかのコマンドライン オプションを受け入れます。--output
: 出力形式を選択します。デフォルトの出力形式(text
)は人間が読める形式です。マシンが読み取れる形式の場合は、proto
または textproto
を使用します。特に、aquery コマンドは通常の Bazel ビルド上で実行され、ビルド中に使用可能なオプションのセットを継承します。
従来のプラットフォームでも利用できるのと同じ機能セットを
query
、ただし siblings
、buildfiles
、
tests
。
詳細については、アクショングラフ クエリをご覧ください。
その他のコマンドとオプション
help
help
コマンドは、オンライン ヘルプを提供します。デフォルトでは、
使用可能なコマンドの概要とヘルプトピックが、図に示すように表示されます。
Bazel を使用したビルド。
引数を指定すると、特定のトピックに関する詳細なヘルプが表示されます。ほとんどのトピックは Bazel コマンド(build
や query
など)ですが、コマンドに対応していないヘルプトピックもあります。
--[no]long
(-l
)
デフォルトでは、bazel help [topic]
は a
トピックに関連するオプションの概要です条件
--long
オプションが指定されている場合、タイプ、デフォルト値
各オプションの詳細な説明も表示されます。
shutdown
Bazel サーバー プロセスは、shutdown
を使用して停止できます。
使用できます。このコマンドを実行すると、Bazel サーバーはすぐに終了します
アイドル状態になる(たとえば、ビルドやその他の依存関係の
コマンドなど)が表示されます。詳しくは、
クライアント/サーバーの実装。
Bazel サーバーはアイドル状態のタイムアウト後に停止するため、このコマンドが必要になることはほとんどありません。ただし、特定のワークスペースでこれ以上ビルドが行われないことがわかっている場合は、スクリプトで役立ちます。
shutdown
は 1 つのオプション(--iff_heap_size_greater_than _n_
)を受け入れます。このオプションには整数引数(MB 単位)が必要です。指定すると、シャットダウンします。
すでに消費されているメモリの量に左右されますこれは、多くのビルドを開始するスクリプトにとって便利です。Bazel サーバーでメモリリークが発生すると、まれにクラッシュが発生する可能性があります。条件付き再起動を実行すると、この状態を回避できます。
info
info
コマンドは、Bazel サーバー インスタンスまたは特定のビルド構成に関連付けられたさまざまな値を出力します。(ビルドを実行するスクリプトで使用できます)。
また、info
コマンドでは、単一の(オプションの)
引数。これは、以下のリストに示すキーのいずれかの名前です。
この場合、bazel info key
は 1 つのキーの値のみを出力します。(これは、
Bazel を使用すると、結果をパイプ処理する必要がなくなります。
sed -ne /key:/s/key://p
経由:
構成に依存しないデータ
release
: この Bazel インスタンスのリリースラベル。リリース済みバイナリでない場合は「開発版」です。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-size
、committed-heap-size
、max-heap-size
: さまざまな JVM ヒープサイズ パラメータを報告します。それぞれ、現在使用されているメモリ、システムから JVM が使用できることが保証されているメモリ、最大可能な割り当てです。gc-count
、gc-time
: この Bazel サーバーの開始からのガベージ コレクションの累積数と、その実行に要した時間。これらの値は、イベントの開始時にリセットされるわけではなく、 構築できます。package_path
: bazel によってパッケージが検索されるパスのカンマ区切りリスト。形式は--package_path
ビルド コマンドライン引数。
例: Bazel サーバーのプロセス ID。
% bazel info server_pid 1285
構成固有のデータ
これらのデータは、渡された構成オプションの影響を受ける場合があります。
目的地: bazel info
、
例: --cpu
、--compilation_mode
、
info
コマンドは、すべてのリソースを受け入れ、
依存関係を制御するオプション
場所を決定する要素もあるため、分析に
ビルドの出力ディレクトリ、コンパイラの選択など。
bazel-bin
、bazel-testlogs
、bazel-genfiles
: ビルドによって生成されたプログラムが配置されているbazel-*
ディレクトリへの絶対パスを報告します。これは通常、ビルドが成功した後にベース ワークスペース ディレクトリに作成されたbazel-*
シンボリック リンクと同じですが、必ずしも同じではありません。一方、ワークスペース ディレクトリが読み取り専用の場合は、bazel-*
シンボリック リンクを作成できません。シンボリック リンクの存在を前提とせず、bazel info
によって報告された値を使用するスクリプトは、より堅牢になります。- 完全な 「Make」環境。
--show_make_env
フラグが 現在の構成の Make 関数のすべての変数が環境 も表示されます(CC
、GLIBC_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 インスタンスのリリースラベル。リリース済みバイナリでない場合は「開発版」です。バグを報告する際に非常に役立ちます。
bazel --version
は、他の引数がなければ、
bazel version --gnu_format
(開始される可能性があるという副作用を除く)
Bazel サーバーまたはサーバー アーカイブの解凍です。bazel --version
はどこからでも実行できます。ワークスペース ディレクトリは必要ありません。
mobile-install
mobile-install
コマンドは、モバイル デバイスにアプリをインストールします。現時点でサポートされているのは、ART を実行する Android デバイスのみです。
詳細については、bazel mobile-install をご覧ください。
次のオプションがサポートされています。
--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_s:
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
オプションを使用すると、さまざまなイベントの中から
使用できます。現時点では、build
と test
のみがサポートされています。指定したコマンドがサポートしていないオプションを使用すると、エラーが発生します。
例:
% 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
このコマンドでは、2 つの Bazel コマンドが同時に実行されます(
シェルの &
オペレーターなど)、それぞれ異なる Bazel を使用
必要があります(出力ベースが異なるため)。
一方、デフォルトの出力ベースを両方のコマンドで使用した場合、
この場合、両方のリクエストが同じサーバーに送信され、
順番に処理します。まず //foo
をビルドし、その後で
//bar
の増分ビルドで行われます。
--output_user_root=dir
出力ベースとインストール ベースが作成されるルート ディレクトリを参照します。ディレクトリ 呼び出し元のユーザーに存在していないか、オーナーになっている必要があります。これまでは これにより、さまざまなユーザー間で共有されているディレクトリを指すことが許可されていました。 今や許可されていませんこれが許可されるのは 1 回だけです。 問題 #11100 に対処しています。
--output_base
オプションを指定すると、--output_user_root
を使用して出力ベースを計算するオーバーライドが適用されます。
インストール ベースの場所は、--output_user_root
と Bazel 埋め込みバイナリの MD5 ID に基づいて計算されます。
--output_user_root
オプションを使用すると、
すべての Bazel 出力(インストール ベースと出力)の代替ベースの場所
(ベース)に指定します。
--server_javabase=dir
Bazel 自体が実行される Java 仮想マシンを指定します。値にはパスを ディレクトリに配置されます。ラベルは使用できません。このオプションは、任意の 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 には影響しません。bazel
run
で実行するかコマンドラインで実行するかにかかわらず、JVM オプションを実行可能 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
を使用すると、明示的な JRE を選択して、
Bazel を実行します。
--batch
バッチモードでは、Bazel は標準のクライアント / サーバー モードを使用しません。代わりに、単一のコマンドに対して bazel java プロセスを実行します。これは、シグナル処理、ジョブ制御、環境変数の継承に関してより予測可能なセマンティクスに使用され、chroot ジャイルで bazel を実行するために必要です。
バッチモードでは、同じ output_base 内で適切なキューイング セマンティクスが保持されます。つまり、同時呼び出しは重複なく順番に処理されます。 サーバーが実行されているクライアントでバッチモードの Bazel が実行されている場合は、 サーバーを強制終了してからコマンドを処理します。
Bazel は、バッチモードまたは上記の代替方法で実行すると、実行速度が遅くなります。これは特に、ビルドファイルのキャッシュがメモリ常駐であり、 保持されるようにする必要があります したがって、パフォーマンスがそれほど重要でない場合は、バッチモードを使用することをおすすめします(継続的ビルドなど)。
--max_idle_secs=n
このオプションは、最後のクライアント リクエスト後に Bazel サーバー プロセスが終了するまでの待機時間を秒単位で指定します。「
デフォルト値は 10,800(3 時間)です。--max_idle_secs=0
を指定すると、Bazel サーバー プロセスが無期限に保持されます。
このオプションは、Bazel を呼び出すスクリプトで
Bazel サーバー プロセスをユーザーのマシンに残さないようにする
実行されません。
たとえば、送信前スクリプトで bazel query
を呼び出して、ユーザーの保留中の変更によって望ましくない依存関係が導入されないようにすることができます。ただし、
そのワークスペースで最近ビルドを行っていない場合、
presubmit スクリプトで Bazel サーバーを起動することは望ましくありません。
その日はアイドル状態のままになります
リソースに小さな --max_idle_secs
値を指定すると、
クエリ リクエストによって新しいクエリ リクエストが発生した場合、
そのサーバーは直ちに終了しますが、
存在する場合は、そのサーバーは引き続き実行され、
通常の時間アイドル状態が続きますもちろん、既存のサーバーでアイドル タイマーがリセットされます。
--[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
ベスト エフォート I/O スケジューリングのレベルを 0~7 の間で設定します。0 が最も優先度が高く、 7 が最も低いです。予測スケジューラが尊重できる優先度は 4 までです。 負の値は無視されます。
--batch_cpu_scheduling
Bazel に batch
CPU スケジューリングを使用します。このポリシーは次の場合に役立ちます。
非インタラクティブだが、nice 値を下げたくないワークロードに最適です。
「man 2 sched_setscheduler」をご覧ください。このポリシーでは、Bazel のスループットを犠牲にして、システムのインタラクティビティを向上させることができます。
その他のオプション
--[no]announce_rc
起動時に Bazel が bazelrc ファイルから読み取った起動オプションとコマンド オプションを通知するかどうかを制御します。
--color (yes|no|auto)
このオプションは、Bazel で色を使用してハイライト表示するかどうかを指定します 変換されます。
このオプションを yes
に設定すると、カラー出力が有効になります。
このオプションを auto
に設定した場合、Bazel は次の場合にのみカラー出力を使用します。
出力がターミナルに送信され、TERM 環境変数が
dumb
、emacs
、xterm-mono
以外の値が設定されている。
このオプションを no
に設定すると、カラー出力は無効になります。
出力がターミナルに送信されるかどうかに関係なく
TERM 環境変数の設定によります。
--config=name
追加の設定セクションを以下から選択
rc ファイル現在のcommand
また、そのようなセクションが存在する場合は、command:name
からオプションを取得します。可能
複数回指定して、複数の config セクションからフラグを追加します。展開は、他の 1 つの
(たとえば、拡張を連結できます)。
--curses (yes|no|auto)
このオプションは、Bazel が画面出力でカーソル コントロールを使用するかどうかを決定します。その結果、スクロールするデータ量が減り、
Bazel からの出力のコンパクトで読みやすいストリーム。この方法は
--color
。
このオプションが yes
に設定されている場合、カーソル操作が有効になります。このオプションを no
に設定した場合、カーソル制御の使用は無効になります。
このオプションを auto
に設定すると、--color=auto
の場合と同じ条件でカーソル コントロールの使用が有効になります。
--[no]show_timestamps
指定すると、によって生成される各メッセージにタイムスタンプが メッセージが表示された時刻を指定する Bazel。