このページでは、bazel build
、bazel run
、bazel test
などのさまざまな Bazel コマンドで使用できるオプションについて説明します。このページはコンパニオンです
Bazel を使用したビルドの Bazel のコマンドのリストをご覧ください。
ターゲットの構文
build
や test
などの一部のコマンドは、ターゲットのリストを操作できます。Google
ラベルよりも柔軟な構文を使用します。これについては、
ビルドするターゲットの指定。
オプション
以降のセクションでは、ビルド時に使用できるオプションについて説明します。--long
をヘルプコマンドで使用すると、オンライン ヘルプ メッセージに、各オプションの意味、タイプ、デフォルト値に関する概要情報が表示されます。
ほとんどのオプションは 1 回しか指定できません。複数回指定すると、 最後のインスタンスが優先します複数回指定できるオプションは、オンライン ヘルプで「複数回使用可能」というテキストで示されています。
パッケージの場所
--package_path
このオプションは、特定のパッケージの BUILD ファイルを検索するために検索されるディレクトリのセットを指定します。
Bazel は、パッケージパスを検索してパッケージを見つけます。これは、各部分ソースツリーのルートである Bazel ディレクトリのコロンで区切られた順序付きリストです。
--package_path
オプションを使用してカスタム パッケージ パスを指定するには:
% bazel build --package_path %workspace%:/some/other/root
パッケージ パス要素は、次の 3 つの形式で指定できます。
- 最初の文字が
/
の場合、パスは絶対パスです。 - パスが
%workspace%
で始まる場合、パスは最も近いバゼル ディレクトリを基準として相対的に取られます。たとえば、作業ディレクトリ内に/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 では、パッケージを Terraform Registry に ため、空の 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
このオプションは、ソースファイルのリンカーに渡す引数を受け取ります。
実行構成ファイル内にコンパイルされます。これは --linkopt
オプションに似ていますが、exec 構成にのみ適用されます。
--conlyopt=cc-option
このオプションは、C ソースファイルをコンパイルするときにコンパイラに渡す引数を受け取ります。
これは --copt
に似ていますが、C コンパイルにのみ適用されます。
C++ のコンパイルやリンクには関係しません。C 固有のオプションを渡すことができます。
(-Wno-pointer-sign
など)。--conlyopt
を使用します。
--cxxopt=cc-option
このオプションは引数を取り、 C++ ソースファイルのコンパイルに役立ちます。
これは --copt
に似ていますが、C++ コンパイルにのみ適用されます。
C コンパイルやリンクには関係ありません。そのため、C++ 固有のオプションを
(-fpermissive
、-fno-implicit-templates
など)。--cxxopt
を使用します。
例:
% bazel build --cxxopt="-fpermissive" --cxxopt="-Wno-error" //foo/cruddy_code
--linkopt=linker-option
このオプションは、リンク時にコンパイラに渡す引数を取ります。
これは --copt
に似ていますが、コンパイルにではなく、リンクにのみ適用されます。そのため、意味がある場合にのみコンパイラ オプションを
リンク時(-lssp
、-Wl,--wrap,abort
など)
--linkopt
を使用します。例:
% 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
これは、生成時に strip
コマンドに渡す追加のオプションです。
*.stripped
バイナリ。デフォルト
-S -p
です。このオプションは複数回使用できます。
--fdo_instrument=profile-output-dir
--fdo_instrument
オプションを使用すると、
エラー発生時に FDO(Feedback Directed Optimization)プロファイルが出力されます。
ビルドされた C/C++ バイナリが実行されます。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 の場合、
前に生成されたファイルツリーを含む zip ファイルが提供されます。
各 .o ファイルのプロフィール情報を含む .gcda ファイルの数。
また、指定された引数は、拡張子 .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、14、15 です。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
です。値を拡張するには、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
は、サーバー VM を使用してすべての Java バイナリを起動し、VM の起動ヒープサイズを 256 MB に設定します。
--javacopt=javac-option
このオプションを使用すると、オプションの引数を javac に渡すことができます。使用可能な 複数の引数を指定して実行することもできます。例:
% bazel build --javacopt="-g:source,lines" //myprojects:prog
は、javac のデフォルトのデバッグ情報(bazel のデフォルトではなく)を使用して java_binary を再ビルドします。
このオプションは、Bazel の組み込みデフォルト オプションの後に javac に渡されます。 ルールごとのオプションの前に挿入します。javac へのオプションの最後の仕様が優先されます。javac のデフォルトのオプションは次のとおりです。
-source 8 -target 8 -encoding UTF-8
--strict_java_deps (default|strict|off|warn|error)
このオプションは、javac が直接依存関係の欠落を確認するかどうかを制御します。Java ターゲットでは、直接使用されるすべてのターゲットを明示的に依存関係として宣言する必要があります。このフラグは、実際に使用された JAR を確認するように javac に指示します。 各 Java ファイルの型チェック用。出力ファイルでない場合は warn/error 現在のターゲットの直接的な依存関係になります。
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
オプションは、Bazel に次の動作を指示します。
extra_actions
をスケジュールするターゲットのセットをフィルタします。
このフラグは、--experimental_action_listener
フラグと組み合わせてのみ適用されます。
デフォルトでは、すべての extra_actions
ビルドをリクエストしたターゲットの実行がスケジュールされます。
--experimental_extra_action_filter
は、所有者のラベルが指定された正規表現と一致する extra_actions
にスケジュールを制限します。
次の例では、extra_actions
のスケジューリングを制限します。
次のようにして、所有者のラベルに「/bar/」が含まれるアクションにのみ適用されるようにします。
% bazel build --experimental_action_listener=//test:al //foo/... \ --experimental_extra_action_filter=.*/bar/.*
--host_cpu=cpu
このオプションは、ホストツールのビルドに使用する CPU アーキテクチャの名前を指定します。
--android_platforms=platform[,platform]*
推移的 deps
を構築するためのプラットフォーム
android_binary
ルール(特に C++ などのネイティブ依存関係の場合)。対象
たとえば、cc_library
がフィールドの推移的 deps
に出現する場合、
android_binary
ルールは、指定されたプラットフォームごとに 1 回ビルドされます。
android_binary
ルールに対して --android_platforms
、最終的な
出力です。
このフラグにはデフォルト値はありません。カスタムの Android プラットフォームは、 使用されます。
1 つの .so
ファイルが作成され、指定されたプラットフォームごとに APK にパッケージ化されます。
--android_platforms
に置き換えます。.so
ファイルの名前は、
「lib」を含む android_binary
ルール。たとえば、
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
のように使用できます。これにより、base
というディレクトリ内のすべての .pb.cc
ファイルが一致します。
このオプションは複数回使用できます。
このオプションは、使用されるコンパイルモードに関係なく適用されます。たとえば
--compilation_mode=opt
でコンパイルし、一部を選択してコンパイルする
[より強力な最適化] がオンか、または [オフ] に設定されているファイルを表示することもできます。
注意: 一部のファイルがデバッグ シンボルで選択的にコンパイルされている場合、リンク時にシンボルが削除されることがあります。これを回避するには、
--strip=never
。
構文: [+-]regex[,[+-]regex]...@option[,option]...
regex
は正規表現を表します。この正規表現には接頭辞として
+
で包含パターンを識別し、-
で識別
除外パターンを確認できますoption
は、C++ コンパイラに渡される任意のオプションを表します。オプションに ,
が含まれている場合は、\,
のように引用符で囲む必要があります。Options に @
を含めることもできます。これは最初の要素のみであるため、
@
は、正規表現とオプションを区切るために使用します。
例:
--per_file_copt=//foo:.*\.cc,-//foo:file\.cc@-O0,-fprofile-arcs
-O0
オプションと -fprofile-arcs
オプションをコマンドに追加します。
//foo/
内のすべての .cc
ファイル(file.cc
を除く)用の C++ コンパイラの行。
--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
このフラグが設定されている場合、linkopt にある -static
オプション
cc_*
ルールの BUILD ファイルは無視されます。これは単に
C++ 強化ビルドの回避策について説明します。
--[no]force_pic
有効にすると、すべての C++ コンパイルで位置独立コード(「-fPIC」)が生成され、リンクでは PIC 以外のライブラリよりも PIC ビルド済みライブラリが優先され、リンクで位置独立実行可能ファイル(「-pie」)が生成されます。デフォルトは無効になっています。
--android_resource_shrinking
android_binary ルールに対してリソース圧縮を実行するかどうかを選択します。デフォルトの shrink_resources 属性(オン) android_binary ルールそのルールのドキュメントをご覧くださいデフォルトはオフです。
--custom_malloc=malloc-library-target
指定すると、指定した Maloc 実装が常に使用され、
malloc="target"
属性(
(malloc
を指定しないことにより)します。
--crosstool_top=label
このオプションは、クロスツール コンパイラ スイートの場所を指定します
ビルド時のすべての C++ コンパイルに使用できます。Bazel は、その場所で CROSSTOOL ファイルを検索し、それを --compiler
の設定を自動的に決定するために使用します。
--host_crosstool_top=label
指定しない場合、Bazel は --crosstool_top
の値を使用して、ビルド中に実行されるツールなど、exec 構成内のコードをコンパイルします。このフラグの主な目的は
クロスコンパイルを有効にすることです。
--apple_crosstool_top=label
次の推移的 deps
で C/C++ ルールをコンパイルするために使用するクロスツール
3 つのルールがあります。*、apple*そうしたターゲットの場合、このフラグは
--crosstool_top
。
--android_crosstool_top=label
次の推移的 deps
で C/C++ ルールをコンパイルするために使用するクロスツール
android_binary
ルール。これは、ビルド内の他のターゲットに別のクロスツールが必要な場合に便利です。デフォルトでは、クロスツールは
WORKSPACE ファイルの android_ndk_repository
ルールで生成されます。
関連情報: --android_platforms
.
--compiler=version
このオプションは、ビルド中にバイナリのコンパイルに使用する C/C++ コンパイラ バージョン(gcc-4.1.0
など)を指定します。カスタム クロスコツールでビルドする場合は、このフラグを指定する代わりに CROSSTOOL ファイルを使用する必要があります。
--android_sdk=label
非推奨です。直接指定しないでください。
このオプションでは、Android SDK/プラットフォーム ツールチェーンを指定します および Android ランタイム ライブラリです。これらは、Android 関連の 適用できます。
android_sdk_repository
が存在する場合、Android SDK は自動的に選択されます。
WORKSPACE ファイルに定義されています。
--java_toolchain=label
このオプションは、Java ソースファイルのコンパイルに使用される java_toolchain のラベルを指定します。
--host_java_toolchain=label
指定しない場合、bazel は --java_toolchain
の値を使用して、ビルド中に実行されるツールなど、exec 構成でコードをコンパイルします。このフラグの主な目的は、クロスコンパイルを有効にすることです。
--javabase=(label)
このオプションは、bazel run、bazel test、および java_binary
ルールと java_test
ルールによってビルドされた Java バイナリに使用するベース Java インストールのラベルを設定します。JAVABASE
と JAVA
の「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
「Compiling //foo/bar/baz」を実行sandboxed
戦略ですが、逆方向です。 注文ではlocal
を使用して実行されます。 - 例:
--strategy_regexp='Compiling.*/bar=local,sandboxed'
はlocal
戦略で「Compiling //foo/bar/baz」を実行し、失敗した場合は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」ツリーは通常、対応するバイナリまたはテストの兄弟としてルートされます。テスト実行中、次の形式のパスを使用して runfile にアクセスできます。
$TEST_SRCDIR/workspace/packagename/filename
。
runfiles ツリーにより、テストは宣言された依存関係を持つすべてのファイルにアクセスできます。方法
runfiles ツリーは、
必要なファイルへのシンボリック リンクを提供します。リンクセットの増加に伴い、このオペレーションのコストも増加します。特に、個々のテスト(またはアプリケーション)に独自の runfiles ツリーが必要なため、大規模なビルドでは全体的なビルド時間に大きく影響する可能性があります。
--[no]build_runfile_manifests
このオプション(デフォルトで有効)は、Runfile マニフェストを
出力ツリーに書き込む必要があります。
無効にすると、--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
指定すると、Bazel は、サイズ、タイムアウト、タグ、言語が原因でフィルタされなかった *_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]*
指定すると、Bazel は指定されたサイズのテストターゲットのみをテストします(--build_tests_only
も指定されている場合はビルドします)。テストサイズ フィルタ
は、許可されるテストサイズ値(小、
(中、大、巨大)、必要に応じて先頭に「-」を付ける記号の意味は、
除外されたテストサイズです次に例を示します。
% 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/...
foo_test
または bar_test
のインスタンスであるターゲットのみがテストされます。
//baz/...
であり、
% bazel test --test_lang_filters=-foo,-bar //baz/...
//baz/...
のすべてのターゲット(foo_test
と
bar_test
個のインスタンス。
--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 つの
ビルド ターゲットを指定すると、Bazel は、
ターゲットが最新に正常に更新されているかどうか、
ターゲットによって作成された出力ファイルのリスト。複数の場合
ターゲットが指定された場合、結果情報は表示されません。
結果情報は、単一のターゲットまたは少数のターゲットのビルドには役立ちますが、大規模なビルド(トップレベルのプロジェクト ツリー全体など)では、この情報が多くて気が散る可能性があります。このオプションを使用すると、この情報を制御できます。--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 はスタンプ付きアクションを再実行します。 したがって、安定したステータスにはタイムスタンプなどの値を含めないでください。タイムスタンプは常に変化するため、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
: ビルド時刻。形式は次のとおりです。yyyy MMM d HH mm ss EEE
(例: 2023 Jun 2 01 44 29 Fri)を UTC で表記します。
Linux/macOS では、--workspace_status_command=/bin/true
を
ワークスペース ステータスの取得を無効にします。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
属性。詳細については、構築百科事典をご覧ください。日時
ルールで stamp = -1
(*_binary
ルールのデフォルト)が設定されている場合、このオプション
スタンプが有効かどうかを決定します
Bazel は、このオプションや stamp
属性に関係なく、exec 構成用にビルドされたバイナリにスタンプを押すことはありません。stamp =
0
(*_test
ルールのデフォルト)を設定するルールの場合、--[no]stamp
に関係なくスタンプは無効になります。--stamp
を指定しても、依存関係が変更されていない場合、ターゲットの再ビルドは強制されません。
--nostamp
の設定は、ビルドのパフォーマンスを向上させるため、一般的に推奨されます。
入力の変動性が低減し、ビルド キャッシュが最大化されます。
プラットフォーム
これらのオプションを使用して、ビルドの動作を構成するホストとターゲットのプラットフォームを制御し、 Bazel ルールで使用できる実行プラットフォームとツールチェーンを制御します。
--platforms=labels
ターゲットとするプラットフォームを記述するプラットフォーム ルールのラベル 確認できます。
--host_platform=label
ホストシステムを記述するプラットフォーム ルールのラベル。
--extra_execution_platforms=labels
アクションを実行する実行プラットフォームとして使用できるプラットフォーム。プラットフォームは正確なターゲットで、またはターゲット パターンとして指定できます。これらのプラットフォームは、register_execution_platforms() によって WORKSPACE ファイルで宣言されたプラットフォームよりも前に考慮されます。このオプションでは、優先順位に従ってプラットフォームをカンマ区切りのリストで指定できます。フラグが複数回渡された場合は、最新のオーバーライドが適用されます。
--extra_toolchains=labels
ツールチェーン解決時に考慮されるツールチェーン ルール。ツールチェーンは、正確なターゲットまたはターゲット パターンで指定できます。これらのツールチェーンは、 WORKSPACE ファイルで宣言されたものよりも前に、 register_toolchains()。
--toolchain_resolution_debug=regex
ツールチェーン タイプが正規表現と一致する場合、ツールチェーンを検索しながらデバッグ情報を出力します。複数の正規表現をカンマで区切って指定できます。正規表現を否定するには、先頭に -
を使用します。デベロッパーにとって
ツールチェーンの欠落によるデバッグエラーがある Bazel ルールまたは Starlark ルール。
その他
--flag_alias=alias_name=target_path
長い Starlark ビルド設定を短い名前にバインドするために使用されるコンビニエンス フラグ。詳細については、Starlark 構成をご覧ください。
--symlink_prefix=string
生成されたコンビニエンス シンボリック リンクの接頭辞を変更します。「
シンボリック リンク接頭辞のデフォルト値は bazel-
で、
シンボリック リンク bazel-bin
、bazel-testlogs
、
bazel-genfiles
。
なんらかの理由でシンボリック リンクを作成できない場合は、 そのビルドは成功とみなされます。特に、読み取り専用ディレクトリや書き込み権限のないディレクトリをビルドできます。情報提供用のパスとして表示される メッセージはビルドの最後に シンボリック リンクが想定されたものを指す場合は、シンボリック リンク相対短縮形 location言い換えれば、これらのデータの正確性を信頼して、 作成されているシンボリック リンクに依存できない場合でも同じです。
このオプションの一般的な値は次のとおりです。
シンボリック リンクの作成を抑制する:
--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 を呼び出すをご覧ください。特に、次のオプションを強くおすすめします。
これらのオプションも重要です。
--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
でテストの失敗とテスト実行がキャッシュに保存される場合があります。
Google Chat でこのオプションをデフォルトで有効にしているユーザー
.bazelrc
ファイルに
略語 -t
(オン)または -t-
(オフ)
特定の実行でデフォルトをオーバーライドする場合に便利です。
--check_tests_up_to_date
このオプションは、テストを実行せず、単にチェックとレポートを生成するように Bazel に指示します キャッシュに保存されたテスト結果まだ実施されていないテストがある場合 テストの結果が古く、 ソースコードやビルド オプションが変更されている場合)は、Bazel による エラー メッセージ(「テスト結果は最新ではありません」)が表示され、テストの ステータスが「ステータスなし」(色出力が有効な場合は赤色)が表示され、 ゼロ以外の終了コードが返されます
このオプションは、[--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 が返されます。 (他の失敗した実行によって 失敗します)。
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
--test_env=variable=_value_
または --test_env=variable
テストに挿入する必要がある追加の変数を指定します
テストごとに 1 つの環境にしますvalue が指定されていない場合は、これが使用されます。
bazel test
の起動に使用されたシェル環境から継承されます
使用できます。
テスト内から環境にアクセスするには、次のコマンドを使用します。
System.getenv("var")
(Java)、getenv("var")
(C または C++)、
--run_under=command-prefix
テストランナーが先頭に挿入する接頭辞を指定します 確認しておく必要があります。command-prefix は Bourne シェルのトークン化ルールを使用して単語に分割され、単語のリストが実行されるコマンドの先頭に追加されます。
最初の単語が完全修飾ラベル(
//
)がビルドされます。ラベルは UDM フィールド値で
コマンドの先頭に追加される、対応する実行可能な場所
他の単語と一緒に実行されます
いくつかの注意点があります。
- テストの実行に使用される 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
と類似していますが、次の点が異なります。
単一のターゲットをビルドして実行するために使用されます。一般的なセッションを次に示します。
% 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 によってビルドされたバイナリを直接呼び出す場合と似ていますが、同じではありません。その動作は、呼び出されるバイナリがテストかどうかによって異なります。
バイナリがテストでない場合、現在の作業ディレクトリは runfiles ツリーを使用します。
バイナリがテストの場合、現在の作業ディレクトリが実行ルートになり、通常テストが実行される環境を再現するために誠意を持って試行されます。ただし、エミュレーションは完全ではなく、複数のシャードを含むテストはこのように実行できません(--test_sharding_strategy=disabled
コマンドライン オプションを使用して回避できます)。
バイナリでは、次の追加の環境変数も使用できます。
BUILD_WORKSPACE_DIRECTORY
: コンテナがホストされているワークスペースのルート ビルドが実行されました。BUILD_WORKING_DIRECTORY
: 現在の作業ディレクトリ。 Bazel の実行元。
たとえば、コマンドラインでファイル名を解釈するために、 作成しました。
「bazel run
」のオプション
--run_under=command-prefix
これは、次の --run_under
オプションと同じ効果があります。
bazel test
(上記参照)、
ただし、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 が分析フェーズの後に実行されることです。これらのツールは 多くの SW エンジニアリングタスクに かけがえのない貴重な支援をしています
クエリ言語は、 グラフに対する代数演算詳しくは、このモジュールの
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 を使用したビルドに示すように、使用可能なコマンドとヘルプトピックの概要が表示されます。引数を指定すると、特定の引数の詳細なヘルプが
説明します。ほとんどのトピックは build
などの Bazel コマンドです
または query
ですが、他にもヘルプトピックがあります。
対応するものがありません。
--[no]long
(-l
)
デフォルトでは、bazel help [topic]
は a
トピックに関連するオプションの概要です--long
オプションを指定した場合は、各オプションの型、デフォルト値、詳細な説明も出力されます。
shutdown
Bazel サーバー プロセスは、shutdown
コマンドを使用して停止できます。このコマンドを実行すると、Bazel サーバーはすぐに終了します
アイドル状態になる(たとえば、ビルドやその他の依存関係の
コマンドなど)が表示されます。詳細については、クライアント / サーバーの実装をご覧ください。
Bazel サーバーはアイドル状態のタイムアウト後に停止するため、このコマンドが必要になることはほとんどありません。ただし、特定のワークスペースでこれ以上ビルドが行われないことがわかっている場合は、スクリプトで役立ちます。
shutdown
が承認
オプション --iff_heap_size_greater_than _n_
は、
整数の引数(MB 単位)が必要です。指定すると、シャットダウンします。
すでに消費されているメモリの量に左右されますこれは、
大量のビルドを開始するスクリプトで有用です。たとえば、
Bazel サーバーでリークが発生すると、電源の問題が
occasion;条件付き再起動を実行すると、この条件がプリエンプトされます。
info
info
コマンドは、Bazel サーバー インスタンスまたは特定のビルド構成に関連付けられたさまざまな値を出力します。(ビルドを実行するスクリプトで使用できます)。
また、info
コマンドでは、単一の(オプションの)
引数。これは、以下のリストに示すキーのいずれかの名前です。
この場合、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 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
。
--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 は次のタイミングで Bazel にチェックインされます。
third_party/allocation_instrumenter/java-allocation-instrumenter-3.3.0.jar
なので、
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 仮想マシンの起動に影響し、そのサーバーで処理される後続のすべてのコマンドに適用されます。すでに 起動オプションが一致しない場合、 再起動されます。
このセクションで説明するオプションはすべて、--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
出力ベースとインストール ベースが作成されるルート ディレクトリを参照します。ディレクトリ 呼び出し元のユーザーに存在していないか、オーナーになっている必要があります。以前は、さまざまなユーザー間で共有されるディレクトリを参照することが許可されていましたが、現在は許可されていません。これは、問題 #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 引数として解釈されますが、この機能はまもなく 非推奨です。
これは、アプリケーションによって使用される 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
このオプションを使用すると、インストールされた JDK を起動時に Bazel が自動的に検索します。
組み込みの JRE が使用できない場合は、インストール済みの JRE にフォールバックできます。
--explicit_server_javabase
を使用すると、Bazel を実行する明示的な JRE を選択できます。
--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 サーバー プロセスがユーザーのマシンに残されないようにします。たとえば presubmit スクリプトは
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 セクションからフラグを追加します。展開は他の定義を参照できます(展開を連結できます)。
--curses (yes|no|auto)
このオプションは、Bazel が画面出力でカーソル コントロールを使用するかどうかを決定します。これにより、スクロールするデータが減り、Bazel からの出力ストリームがコンパクトになり、読みやすくなります。この方法は
--color
。
このオプションが yes
に設定されている場合、カーソル操作が有効になります。このオプションを no
に設定した場合、カーソル制御の使用は無効になります。
このオプションを auto
に設定した場合は、カーソル コントロールが使用されます。
--color=auto
と同じ条件で有効になります。
--[no]show_timestamps
指定すると、によって生成される各メッセージにタイムスタンプが メッセージが表示された時刻を指定する Bazel。