本頁面說明各種 Bazel 指令都能使用的選項
例如 bazel build
、bazel run
和 bazel test
這個網頁是隨播廣告
複製到 Build with Bazel 中 Bazel 的指令清單。
目標語法
部分指令 (例如 build
或 test
) 可以對目標清單執行作業。它們使用的語法比標籤更具彈性,詳情請參閱「指定要建構的目標」一文。
選項
以下各節將說明建構期間可用的選項。當 --long
用於說明指令時,線上說明訊息會提供每個選項的含義、類型和預設值的摘要資訊。
大部分選項只能指定一次。多次指定時, 最後,當個例項獲勝。可以多次指定的選項如下 透過線上說明獲得「可能用於多次」的文字。
套件位置
--package_path
警告:--package_path
選項已淘汰。Bazel 偏好使用套件
放在工作區根目錄下。
這個選項會指定要搜尋的一系列目錄,以便找出指定套件的 BUILD 檔案。
Bazel 會搜尋套件路徑,找出套件。這是冒號 分離的 bazel 目錄清單,每個目錄都是 部分來源樹狀結構。
使用 --package_path
選項指定自訂套件路徑:
% bazel build --package_path %workspace%:/some/other/root
您可以使用三種格式指定套件路徑元素:
- 如果第一個字元是
/
,則路徑為絕對路徑。 - 如果路徑的開頭為
%workspace%
,則會採用相對路徑 拖曳到最近的 Bazel 目錄。 舉例來說,如果您的工作目錄 為/home/bob/clients/bob_client/bazel/foo
,則 套件路徑中的字串%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 建立建構作業 工作區 (如果能在其他位置找到所有必要套件) 。
範例:從空的用戶端建構
% 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++ 或組譯器程式碼時,都會將引數傳遞至編譯器。連結時不會傳遞。
這個選項可以重複使用。例如:
% bazel build --copt="-g0" --copt="-fpic" //foo
會在不使用偵錯資料表的情況下編譯 foo
程式庫,
獨立程式碼
--host_copt=cc-option
這個選項會採用一個引數,該引數會傳遞至編譯器,用於在執行設定中編譯來源檔案。類似於
--copt
選項,但僅適用於
exec 設定
--host_conlyopt=cc-option
這個選項會採用引數,並將其傳遞至編譯器,以便在執行設定中編譯 C 來源檔案。類似於
--conlyopt
選項,但僅適用於
移至執行設定
--host_cxxopt=cc-option
這個選項採用引數,要傳遞至 C++ 來源檔案的編譯器
執行編譯作業這與 --cxxopt
選項類似,但只適用於執行設定。
--host_linkopt=linker-option
這個選項會採用一個引數,該引數會傳遞至執行設定中編譯的來源檔案連結器。這與 --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
類似,但僅適用於連結、
未經編譯。因此,您可以傳遞僅適用於
於連結時 (例如 -lssp
或 -Wl,--wrap,abort
)
使用 --linkopt
。例如:
% bazel build --copt="-fmudflap" --linkopt="-lmudflap" //foo/buggy_code
建構規則也可以在屬性中指定連結選項。這個選項的 設定一律會優先採用另請參閱 cc_library.linkopts。
--strip (always|never|sometimes)
這個選項會決定 Bazel 是否會從以下來源移除偵錯資訊:
使用 -Wl,--strip-debug
選項叫用連結器,藉此擷取所有二進位檔和共用程式庫。
--strip=always
表示一律要移除偵錯資訊。--strip=never
表示絕對不會移除偵錯資訊。
如果 --compilation_mode
為 fastbuild
,--strip=sometimes
的預設值表示要移除。
% 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
,因此您只能設定其中一個。
如果只建構單一二進位檔,想要移除所有符號,也可以
傳遞 --stripopt=--strip-all
並明確建構
目標的 //foo:bar.stripped
版。如 --stripopt
一節所述,此方法會在連結最終二進位檔後套用去除動作,而不是在所有建構連結動作中加入去除動作。
--stripopt=strip-option
這是在產生 *.stripped
二進位檔時,要傳遞至 strip
指令的額外選項。預設
為 -S -p
。這個選項可以重複使用。
--fdo_instrument=profile-output-dir
執行建構的 C/C++ 二進位檔時,--fdo_instrument
選項可用於產生 FDO (反饋導向最佳化) 設定檔輸出內容。如果是 GCC,提供的引數會做為
.gcda 檔案個別物件目錄樹狀結構的目錄前置字串
包含每個 .o 檔案的設定檔資訊
產生設定檔資料樹狀結構後,請將設定檔樹狀結構壓縮,並提供給 --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,提供的引數是包含先前產生的 .gcda 檔案檔案樹狀結構的 ZIP 檔案,其中包含每個 .o 檔案的設定檔資訊。
或者,您也可以使用提供的引數,將其指向由 .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
。
您可以使用 local_java_repository
或 remote_java_repository
存放區規則註冊自訂 JVM,藉此擴充值。
--tool_java_runtime_version=version
用來執行建構期間必要工具的 JVM 版本。
預設值為 remotejdk_11
。
--jvmopt=jvm-option
這個選項可讓選項引數傳遞至 Java VM。可用於 呼叫單一大型引數,或對個別引數多次呼叫。例如:
% 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 目標必須明確將所有直接使用的目標宣告為依附元件。這個標記會指示 javac 判斷實際使用的 jar 檔案 檢查各個 Java 檔案的型別;如果不是輸出內容,則會警告/錯誤 當前目標的直接依附元件。
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]*
建構 android_binary
規則的傳遞 deps
的平台 (特別適用於 C++ 等原生依附元件)。舉例來說,如果 cc_library
出現在 android_binary
規則的傳遞 deps
中,則會針對 android_binary
規則的 --android_platforms
指定的每個平台建構一次,並納入最終輸出內容。
這個標記沒有預設值:您必須定義並使用自訂 Android 平台。
系統會為每個指定平台建立一個 .so
檔案,並封裝在 APK 中
--android_platforms
。.so
檔案名稱會在
含有「lib」的 android_binary
規則。舉例來說,如果 android_binary
的名稱是「foo」,則檔案為 libfoo.so
。
--per_file_copt=[+-]regex[,[+-]regex]...@option[,option]...
存在時,只要 C++ 檔案含有標籤,或是執行路徑與任一納入規則運算式相符的執行路徑,
但與任何排除運算式不相符時,將會建立
與指定的選項搭配使用標籤比對會使用標籤的標準形式 (即 //package
:label_name
)。
執行路徑是指工作區目錄的相對路徑,包括 C++ 檔案的基本名稱 (包括副檔名)。以及所有平台相依的前置字元。
比對產生的檔案 (例如 genrule 輸出內容)
Bazel 只能使用執行路徑。在此情況下,規則運算式的開頭不應是「//」
因為這不符合任何執行路徑套件名稱的使用方式如下:--per_file_copt=base/.*\.pb\.cc@-g0
。這個做法會與
.pb.cc
檔案位於名為 base
的目錄下。
這個選項可以重複使用。
無論使用哪種編譯模式,系統都會套用這個選項。舉例來說
使用 --compilation_mode=opt
編譯並選擇性編譯
或已停用最佳化功能的檔案。
注意事項:如果某些檔案是使用偵錯符號來選擇性編譯,
就可能在連結過程中移除您可以設定 --strip=never
來避免這種情況。
語法:[+-]regex[,[+-]regex]...@option[,option]...
其中
regex
代表可以加上前置字元的規則運算式
會識別包含模式的 +
,並使用 -
識別
排除模式。option
代表傳遞至 C++ 編譯器的任意選項。如果選項包含 ,
,則必須加上引號,例如 \,
。選項也可以包含 @
,因為只有第一個
@
是用來將規則運算式與選項分開。
範例:--per_file_copt=//foo:.*\.cc,-//foo:file\.cc@-O0,-fprofile-arcs
會將 -O0
和 -fprofile-arcs
選項新增至 C++ 編譯器的指令列,適用於 //foo/
中 file.cc
以外的所有 .cc
檔案。
--dynamic_mode=mode
判斷是否要動態連結 C++ 二進位檔,並與建構規則的 linkstatic 屬性互動。
模式:
default
:允許 Bazel 選擇是否要動態連結。詳情請參閱 linkstatic。fully
:動態連結所有目標。這會加快 ,並縮減產生的二進位檔大小。off
:連結以下項目中的所有目標: 「幾乎是靜態的」模式。 如果在 linkopts 中設定-static
,目標就會變更為完全靜態。
--fission (yes|no|[dbg][,opt][,fastbuild])
啟用 Fission、 這個程式會將 C++ 偵錯資訊寫入專屬的 .dwo 檔案 (而不是 .o 檔案), 否則就會跳出去可大幅減少連結的輸入大小,並縮短連結時間。
如果設為 [dbg][,opt][,fastbuild]
(例如 --fission=dbg,fastbuild
),則只有在指定的編譯模式組合中啟用 Fission。這對 bazelrc 設定非常實用。如果設為 yes
,系統就會全面啟用 Fission。如果設為 no
,系統就會全面停用 Fission。預設值為 no
。
--force_ignore_dash_static
如果設定此標記,則任何 -static
選項的連結選擇
系統會忽略 cc_*
規則 BUILD 檔案。這項功能僅供
C++ 強化版本的解決方法。
--[no]force_pic
啟用後,所有 C++ 編譯都會產生與位置無關的程式碼 (「-fPIC」), 連結更偏好使用 PIC 預先建構的程式庫,而非非 PIC 程式庫,而且連結會產生 位置獨立的可執行檔 (「-pie」)。已停用預設值。
--android_resource_shrinking
選取是否要針對 android_binary 規則執行資源縮減作業。為 android_binary 規則設定 shrink_resources 屬性的預設值。詳情請參閱該規則的說明文件。預設為關閉。
--custom_malloc=malloc-library-target
如果有指定,請一律使用指定的 Malloc 實作項目,覆寫所有項目
malloc="target"
屬性,包括使用
預設值 (也就是不指定任何 malloc
)。
--crosstool_top=label
這個選項會指定 Crosstool 編譯器套件的位置
,在建構期間用於所有 C++ 編譯。Bazel 會考量
CROSSTOOL 檔案的位置,並透過該位置自動判斷
設定。--compiler
。
--host_crosstool_top=label
如未指定,Bazel 會使用 --crosstool_top
的值編譯
移至 exec 設定中,例如在建構期間執行的工具這個標記的主要目的是啟用交叉編譯。
--apple_crosstool_top=label
在 objc*、ios* 和 apple* 規則的傳遞 deps
中,使用 crosstool 編譯 C/C++ 規則。對於這些目標,此標記會覆寫 --crosstool_top
。
--compiler=version
這個選項會指定 C/C++ 編譯器版本 (例如 gcc-4.1.0
)
用於建構二進位檔的編譯作業如果您想
如為自訂跨工具建構,您應使用 CROSSTOOL 檔案,而不是
指定這個標記
--android_sdk=label
已淘汰,請勿直接指定此值。
這個選項會指定 Android SDK/平台工具鏈和 Android 執行階段程式庫,用於建構任何 Android 相關規則。
如果 android_sdk_repository
規則是由 WORKSPACE 檔案定義。
--java_toolchain=label
免人工管理。只為了顧及回溯相容性而保留。
--host_java_toolchain=label
免人工管理。只為了顧及回溯相容性而保留。
--javabase=(label)
免人工管理。只為了顧及回溯相容性而保留。
--host_javabase=label
無操作。僅為回溯相容性而保留。
執行策略
這些選項會影響 Bazel 執行建構作業的方式。 這些指令碼應該不會對輸出檔案造成任何顯著影響 產生的資訊通常,這些設定的主要影響是對建構速度。
--spawn_strategy=strategy
這個選項會控制指令執行的位置和方式。
standalone
會觸發指令做為本機子程序執行。這個值已淘汰。請改用「local
」。sandboxed
會使指令在本機電腦的沙箱中執行。這需要將所有輸入檔案、資料依附性和工具列為直接srcs
、data
和tools
屬性的依附元件。 在支援沙箱執行作業的系統上,Bazel 預設會啟用本機沙箱機制。local
會觸發指令做為本機子程序執行。worker
會使用可用的持續性 worker 執行指令。docker
會讓指令在本機電腦的 Docker 沙箱中執行。 這項操作需要安裝 Docker。remote
會從遠端執行指令;只有 已另外設定遠端執行程式
--strategy mnemonic=strategy
這個選項會控制指令的執行位置和方式,並根據每個助憶法覆寫 --spawn_strategy (以及使用助憶法 Genrule 的 --genrule_strategy)。如要瞭解支援的策略及其影響,請參閱 --spawn_strategy。
--strategy_regexp=<filter,filter,...>=<strategy>
這個選項會指定應使用哪種策略執行描述與特定 regex_filter
相符的指令。如要進一步瞭解如何比對 regex_filter,請參閱 --per_file_copt。如要瞭解支援的策略及其影響,請參閱 --spawn_strategy。
系統會使用最後一個與說明相符的 regex_filter
。這個選項會覆寫
以及指定策略的其他標記
- 範例:
--strategy_regexp=//foo.*\\.cc,-//foo/bar=local
表示如果動作說明與 //foo.*.cc 相符,但與 //foo/bar 不相符,則使用local
策略執行動作。 - 範例:
--strategy_regexp='Compiling.*/bar=local' --strategy_regexp=Compiling=sandboxed
會使用sandboxed
策略執行「Compiling //foo/bar/baz」,但反轉順序後,則會使用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 秒後,以及在每分鐘後列印進度報表。
當 Bazel 使用 --curses
指定的游標控制項時,系統會每秒回報進度。
--local_{ram,cpu}_resources resources or resource expression
這些選項會指定本機資源數量 (以 MB 為單位的 RAM 和 CPU 邏輯核心數量)
將建構與測試活動安排在本機執行時,Bazel 可以考量這一點。拍攝
整數,或選擇關鍵字 (HOST_RAM 或 HOST_CPUS),後面會選擇性加上 [-|*
float]
(例如 --local_cpu_resources=2
、--local_ram_resources=HOST_RAM*.5
、
--local_cpu_resources=HOST_CPUS-1
)。
這些標記各自獨立;您可以設定一個選項,或兩者同時設定。根據預設,Bazel 會預估
例如本機系統設定中的 RAM 和 CPU 核心數量。
--[no]build_runfile_links
這個選項預設為啟用,可指定執行檔案是否
測試和二進位檔的符號連結應建立在輸出目錄中。
使用 --nobuild_runfile_links
可用於驗證是否所有目標都已編譯,且不會產生建構執行檔樹狀結構的額外負擔。
執行測試 (或應用程式) 時,其執行階段資料
依附元件集合在同一處在 Bazel 的輸出樹狀結構中,這個「runfiles」樹狀結構通常會以對應的二進位檔或測試做為根目錄。在測試執行期間,您可以使用 $TEST_SRCDIR/canonical_repo_name/packagename/filename
格式的路徑存取執行檔。執行檔案樹狀結構可確保測試可存取所有檔案
只需宣告一個依附性根據預設,系統會透過建構一組指向必要檔案的符號連結,實作執行檔樹狀結構。隨著連結組合的增加
確實執行此作業的成本,對某些大型版本來說
對整體建構時間的貢獻尤其重要
每項測試 (或應用程式) 都需要自己的 Runfile 樹狀結構。
--[no]build_runfile_manifests
這個選項預設為啟用,可指定是否應將 runfile 資訊清單寫入輸出樹狀結構。停用該值則表示 --nobuild_runfile_links
。
在遠端執行測試時,可以停用此選項,因為執行檔樹狀結構會從記憶體內的資訊清單中遠端建立。
--[no]discard_analysis_cache
啟用這個選項後,Bazel 會在執行作業開始前捨棄分析快取,進而為執行階段釋出額外的記憶體 (約 10%)。缺點是,後續的漸進式建構速度會較慢。另請參閱省記憶體模式。
--[no]keep_going
(-k)
如同 GNU Make,建構作業的執行階段會在遇到第一個錯誤時停止。有時候,即使遇到錯誤,也要盡可能嘗試建構。這個選項會啟用該行為,並在指定時嘗試建構所有前置條件已成功建構的目標,但會忽略錯誤。
雖然這個選項通常與建構作業的執行階段相關,但也會影響分析階段:如果在建構指令中指定了多個目標,但只有部分目標可順利分析,則建構作業會停止並顯示錯誤,除非指定 --keep_going
,否則建構作業會繼續執行階段,但只會針對已順利分析的目標執行。
--[no]use_ijars
這個選項會變更 Bazel 編譯 java_library
目標的方式。與使用 java_library
的輸出內容編譯依附的 java_library
目標不同,Bazel 會建立介面 JAR,其中只包含非私人成員 (public、protected 和預設 (package) 存取方法和欄位) 的簽名,並使用介面 JAR 編譯依附的目標。這樣一來,如果只變更類別的方法主體或私人成員,就不會重新編譯。
--[no]interface_shared_objects
這個選項會啟用「介面共用物件」,進而將二進位檔與 其他共用程式庫仍取決於共用物件的介面。 而非實作本身當 Bazel 只會變更實作項目 可避免重新建立依賴於已變更的共用資料庫 無謂。
輸出選項
這些選項會決定要建構或測試的內容。
--[no]build
這個選項會啟動建構的執行階段。是 預設為啟用。將其關閉時,執行階段會 而且只有前兩階段發生載入和分析時。
這個方法有助於驗證 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 檢查來源檔案的語法,例如重新建構單一 並依來源檔案及早偵測錯誤 可在編輯/建構/測試週期內達成這個引數會影響 非旗標引數會解譯:每個引數都必須是 或是與目前作業相關的純文字檔案名稱 目錄,建立了一個根據每個來源檔案名稱的規則。針對 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 只會建構至少含有一個必要標記的目標 (如有指定) 且沒有任何排除的標記。建構標記篩選器會以逗號分隔的標記關鍵字清單指定,可選擇在前方加上「-」符號,用於表示排除的標記。必要標記也可以 開頭有「+」] 號。
執行測試時,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
時建構)
時) 只會包含至少一個必要代碼的測試目標
(如有指定) 且沒有任何排除的標記。測試標記篩選器會以逗號分隔的標記關鍵字清單指定,並可選擇在前方加上「-」號,用於表示排除的標記。必要標記也可能會在前面加上「+」號。
例如:
% 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/...
將測試 //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
秒最多顯示一則進度訊息。
其中 n 為實數。
這個選項的預設值為 0.02,表示 Bazel 會將進度訊息限制為每 0.02 秒顯示一次。
--show_result=n
這個選項會控制 bazel build
指令結尾的結果資訊輸出作業。根據預設,如果指定單一建構目標,Bazel 會列印訊息,指出目標是否已成功更新,如果是的話,則會列出目標建立的輸出檔案清單。如果指定多個目標,系統不會顯示結果資訊。
雖然結果資訊可能有助於您建立單一的單張圖片
指定目標或少數目標,適用於大型版本 (例如整個頂層項目)
這樣資訊可能會讓人眼花撩亂又分心
這個選項可讓您加以控制--show_result
會採用整數引數,也就是要列印完整結果資訊的目標數量上限。根據預設
這個值會是 1。超過這個門檻,沒有任何結果資訊
但只會在個別指定目標中顯示因此 0 會導致
資訊通常遭到隱藏,如果價值極高
一律顯示結果
如果使用者經常需要
只能建立一小群指定目標 (例如
測試期間) 和大量目標群組
(例如建立新工作區或執行
迴歸測試)。如果情況為另一個情況,結果資訊是
而後者則較不實用與所有情況相同
選項,可透過以下方式以隱含方式指定:
.bazelrc
檔案。
系統會列印檔案,方便您將檔案名稱複製並貼到 Shell 中,以便執行已建構的可執行檔。「最新」 或「失敗」指令碼可輕易剖析每個目標的訊息。 推動建構作業
--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
才能列印
將指令的引數視為清單,而非單行。這可能會
可讓較長的指令列更易於閱讀
另請參閱下方的 --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」檔案。
程式應將零或多個鍵/值組合列印到標準輸出,每行一個項目,然後以零結束 (否則建構作業會失敗)。鍵名可以是任何名稱,但 請使用大寫字母和底線。金鑰名稱後方的第一個空格與 值。值為該行剩餘的部分 (包括其他空格)。無論金鑰或 值可能會橫跨好幾行。金鑰不得重複。
Bazel 將金鑰分成兩個值區:「stable」和「揮發性」(名稱包括「stable」和 「揮發性」有點違反直覺,所以請不要太仔細思考)。
接著,Bazel 會將鍵/值組合寫入兩個檔案:
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 就會重新執行該動作,接著動作會看到更新後的揮發性更新 但如果只是易變狀態變更,就不會導致動作失效。Bazel 一律會輸出下列揮發性鍵:
BUILD_TIMESTAMP
:自 Unix Epoch 時間 (即值) 以來的建構時間,以秒為單位System.currentTimeMillis()
除以一千)FORMATTED_DATE
:版本時間。格式為yyyy MMM d HH mm ss EEE
(例如 2023 年 6 月 2 日 01 點 44 分 29 秒,星期五),以世界標準時間表示。
在 Linux/macOS 上,您可以將 --workspace_status_command=/bin/true
傳送至
停用擷取工作區狀態,因為 true
未執行任何動作 (離開)
且不會顯示任何輸出內容。在 Windows 上,您可以傳遞 MSYS 的 true.exe
路徑,以達到相同效果。
如果工作區狀態指令因任何原因而失敗 (結束時非零),建構作業就會失敗。
使用 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
屬性為何。對於設定 stamp =
0
的規則 (*_test
規則的預設值),無論 --[no]stamp
為何,都會停用沖銷。如果依附元件未變更,指定 --stamp
不會強制重建目標。
設定 --nostamp
通常是為了提升建構效能,因為這樣可降低輸入的不穩定性,並盡可能提高建構快取功能。
平台
使用這些選項控制主機和目標平台,以設定版本的運作方式,並 控管 Bazel 規則可用的執行平台和工具鍊。
--platforms=labels
平台規則的標籤,用來描述 目前的指令
--host_platform=label
說明主機系統的平台規則標籤。
--extra_execution_platforms=labels
可用於執行動作的執行平台。您可以使用精確目標或目標模式來指定平台。系統會先考慮這些平台,再考慮由 register_execution_platforms() 在 MODULE.bazel 檔案中宣告的平台。此選項會以逗號分隔的平台清單,並依優先順序列出。如果多次傳遞此標記,則會使用最新的覆寫值。
--extra_toolchains=labels
工具鍊解析時要考量的工具鍊規則。工具鏈可以使用確切目標或目標模式指定。這些工具鏈會在 register_toolchains() 在 MODULE.bazel 檔案中宣告的工具鏈之前考量。
--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 格式將設定檔寫入指定檔案。
這個選項有助於找出 因為運算過多,導致載入和分析速度變慢。例如:
$ 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 以及由發布工程師準備用於部署的二進位檔 Google 提供端對端開發平台 可將實驗階段的機器學習模型轉換至正式版環境本節列出使用 Bazel 的發布工程師專屬提示。
重要選項
使用 Bazel 進行發布建構作業時,也會出現與其他指令碼相同的問題 執行建構作業詳情請參閱「從指令碼呼叫 Bazel」。特別建議您採用下列選項:
以下選項也很重要:
--package_path
--symlink_prefix
: 針對多項設定管理建構作業 方便您區分每個版本 搭配專屬 ID,例如「64bit」對比「32 位元」。這個選項 區分bazel-bin
(等) 符號連結。
執行測試
如要使用 bazel 建構及執行測試,請輸入 bazel test
,後面加上
測試目標的名稱
根據預設,這項指令會同時執行建構和測試活動,建構所有指定的目標 (包括指令列上指定的任何非測試目標),並在建構前置條件後立即測試 *_test
和 test_suite
目標,也就是說,測試執行作業會與建構作業交錯執行。這通常會大幅提升速度。
「bazel test
」的選項
--cache_test_results=(yes|no|auto)
(-t
)
如果這個選項設為「auto」(預設值),則 Bazel 只會在下列任一情況下重新執行測試:
- Bazel 會偵測測試或其依附元件的變更
- 測試會標示為
external
- 使用
--runs_per_test
要求多次執行測試 - 測試失敗
如果為「否」,則會無條件執行所有測試。
如果為「是」,快取行為就會與自動快取相同,但可能會使用 --runs_per_test
快取測試失敗和測試執行作業。
啟用這個選項的使用者
對方的 .bazelrc
檔案可能會找到
縮寫 -t
(開啟) 或 -t-
(關閉)
方便您覆寫特定執行作業的預設值。
--check_tests_up_to_date
這個選項會指示 Bazel 不要執行測試,而只是檢查及回報 以及快取測試結果如果有任何測試未先建構及執行,或測試結果過時 (例如,因為原始程式碼或建構選項已變更),Bazel 就會回報錯誤訊息 (「測試結果未更新」),並將測試狀態記錄為「NO STATUS」(如果啟用彩色輸出,則會以紅色顯示),並傳回非零的結束碼。
這個選項也意味著
--check_up_to_date
行為。
這個選項可能適用於提交前檢查。
--test_verbose_timeout_warnings
如果測試逾時時間明顯長於測試的實際執行時間,這個選項會指示 Bazel 明確警告使用者。測試時 逾時狀態應設為不易運作,且 過度逾時會隱藏意外自動裁剪的真實問題。
舉例來說,如果測試通常在一兩分鐘內執行,則不應 ETERNAL 或 LONG 的逾時值,但這遠不成問題。
這個選項可協助使用者決定合適的逾時值,或檢查現有的逾時值是否合理。
--[no]test_keep_going
根據預設,系統會執行所有測試,直到完成為止。如果停用這個旗標
但會在任何非傳遞的測試中取消建構。後續的建構步驟
系統不會執行測試叫用,而且會取消執行中的叫用。
請勿同時指定 --notest_keep_going
和 --keep_going
。
--flaky_test_attempts=attempts
這個選項可指定測試的嘗試次數上限
也會失敗一開始失敗但最終的測試
成功的項目在測試摘要中會顯示為 FLAKY
。不過,在識別 Bazel 結束代碼或通過測試的總數時,系統會將其視為通過。系統會將所有允許的失敗次數都失敗的測試視為失敗。
根據預設 (未指定此選項或設為預設值時),系統只允許一般測試執行一次,如果設定了 flaky
屬性,則測試規則可執行 3 次。您可以
整數值,覆寫測試嘗試次數上限。Bazel 允許
最多嘗試 10 次,以免系統遭到濫用。
--runs_per_test=[regex@]number
這個選項會指定每個測試應執行的次數。系統會將所有測試執行作業視為個別測試 (備用功能會個別套用至每項測試)。
執行失敗的目標狀態取決於
--runs_per_test_detects_flakes
標記:
- 否則,任何失敗的執行作業都會導致整個測試失敗。
- 如果存在且兩次執行作業來自同一個資料分割,則傳回 PASS 和 FAIL,測試 狀態就會是很緩慢的 (除非有其他失敗的執行作業導致 失敗)。
如果指定單一數字,系統會執行該次數的所有測試。或者,您也可以使用語法
regex@number。這會限制 --runs_per_test
對符合規則運算式的目標的效果 (--runs_per_test=^//pizza:.*@4
會在 //pizza/
下執行所有測試 4 次)。這個 --runs_per_test
形式可以指定超過一次。
--[no]runs_per_test_detects_flakes
如果指定這個選項 (預設並未指定),Bazel 就會偵測發生問題
透過 --runs_per_test
測試資料分割。單一資料分割的一或多項執行作業時
對同一個資料分割傳遞作業失敗,且執行一或多項執行作業時,目標
與這個旗鼓相當不悅如未指定,目標會回報失敗狀態。
--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
使用指定數量,覆寫所有測試的逾時值。 設為新的逾時值。如果只提供一個值, 皆用於所有測試逾時類別。
或者,您也可以提供四個以半形逗號分隔的值,指定 個別的逾時時間、中度、長效測試和永恆等測試 順序)。 不論是哪一種形式,任何測試大小都會以 0 或負值表示 將由所指定逾時類別的預設逾時換成 按照撰寫測試頁面定義。 根據預設,Bazel 預設會在所有測試中使用這些逾時 根據測試的大小推斷出逾時上限;無論 默示或明確設定
明確指出逾時類別與 優先順序接收的值會與 大小廣告代碼因此,如果測試大小為「small」,並宣告「long」逾時時間,則有效逾時時間會與「large」測試的有效逾時時間相同,但後者沒有明確的逾時時間。
--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
指令只接受一個目標,因此不會出現這種模糊不清的情況。
--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 shell 符記化規則分割成字詞,然後將字詞清單置於要執行的指令前方。
如果第一個字是完整標籤 (開頭為 //
),系統會建構該標籤。接著標籤會替換成
加在指令前的對應可執行位置
與其他字詞一起執行時
但須遵守下列限制:
- 執行測試時使用的 PATH 可能與環境中的 PATH 不同,因此您可能需要為
--run_under
指令 (command-prefix 中的第一個字) 使用絕對路徑。 stdin
未連線,因此--run_under
無法用於互動式指令
範例:
--run_under=/usr/bin/strace --run_under='/usr/bin/strace -c' --run_under=/usr/bin/valgrind --run_under='/usr/bin/valgrind --quiet --num-callers=20'
測試選項
如輸出選取選項所述,您可以依大小、逾時、標記或語言篩選測試。方便使用的一般名稱篩選器可將特定篩選器引數轉送至測試執行器。
「bazel test
」的其他選項
語法和其他選項與 bazel build
完全相同。
執行中的執行檔
bazel run
指令與 bazel build
類似,但用於建構並執行單一目標。這個是典型的練習
(//java/myapp:myapp
說「您好」,並輸出其引數):
% 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 建立的二進位檔及其行為,則視應用程式是否
叫用即可使用的二進位檔
如果二進位檔並未進行測試,目前的工作目錄會是 二進位檔的執行檔案樹狀結構
如果二進位檔是測試,目前的工作目錄會是執行根目錄,並且會盡力複製通常用於執行環境測試的環境。然而,模擬並非完美無缺,而且測試具有多個
無法以這種方式執行 (
可使用「--test_sharding_strategy=disabled
」指令列選項
解決這個問題)
下列額外環境變數也適用於二進位檔:
BUILD_WORKSPACE_DIRECTORY
:工作區的根層級,其中含有BUILD_WORKING_DIRECTORY
:目前的工作目錄,其中 Bazel 的執行位置為
這些字串可用於 例如,在指令列中的 使用起來更方便
「bazel run
」的選項
--run_under=command-prefix
這與 bazel test
的 --run_under
選項具有相同效果 (請參閱上文),但這項選項適用於 bazel
run
執行的指令,而非 bazel test
執行的測試,且無法在標籤下執行。
從 Bazel 篩選記錄輸出
使用 bazel run
叫用二進位檔時,Bazel 會列印來自 Bazel 本身和叫用中的二進位檔的記錄輸出內容。如要減少記錄檔的雜訊,您可以使用 --ui_event_filters
和 --noshow_progress
標記,抑制 Bazel 本身的輸出內容。
例如:bazel run --ui_event_filters=-info,-stdout,-stderr --noshow_progress //java/myapp:myapp
執行測試
bazel run
也可執行測試二進位檔,這類二進位檔
執行測試,相當接近
撰寫測試。請注意,以這種方式執行測試時,除了 --test_arg
以外,其他 --test_*
引數都不會生效。
清理建構作業輸出內容
clean
指令
Bazel 有 clean
指令,類似 Make 指令。系統會刪除所有已執行建構設定的輸出目錄
或由此 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。生成式 AI 和 兩個指令是查詢在載入階段後執行 cquery 會在分析階段執行。這些工具 對許多軟體工程任務而言毫無意義。
查詢語言是以 代數運算如有需要,
Bazel 查詢參考資料。請參考該文件 範例,以及查詢專用指令列選項。
查詢工具接受多個指令列
如果有需要 SQL 指令的分析工作負載
則 BigQuery 可能是最佳選擇--output
會選取輸出格式。--[no]keep_going
(預設為停用) 會讓查詢工具在發生錯誤時繼續進行;如果發生錯誤時無法接受不完整的結果,則可能會停用這項行為。
--[no]tool_deps
選項、
系統會預設啟用,因此非目標設定中的依附元件會包含在
查詢運作時使用的依附關係圖。
--[no]implicit_deps
選項 (預設為啟用)
隱含依附元件,要包含在查詢作業所在的依附元件圖表中。隱含依附元件是指未在 BUILD 檔案中明確指定,但由 Bazel 新增的依附元件。
例如:「在 BUILD 檔案中顯示定義位置 (在 BUILD 檔案中) 所有測試在 PEBL 樹狀結構中建構所有測試所需的 Genrules。」
bazel query --output location 'kind(genrule, deps(kind(".*_test rule", foo/bar/pebl/...)))'
查詢動作圖
aquery
指令可讓您查詢建構圖中的動作。它會針對已設定後分析的目標圖表運作,並提供有關動作、構件及其關係的資訊。
這項工具接受多種指令列選項。
--output
會選取輸出格式。預設輸出格式
(text
) 是人類可讀的格式,proto
或 textproto
適用於
機器可讀取的格式
值得注意的是,查詢指令會在一般 Bazel 建構作業之上執行,並沿用
建構期間可用的選項組合
可支援的函式也適用於
query
,但siblings
、buildfiles
和
tests
。
詳情請參閱「動作圖查詢」。
其他指令和選項
help
help
指令提供線上說明。根據預設
會顯示可用指令和說明主題的摘要,如
使用 Bazel 建構。
指定引數會顯示系統提供特定服務的詳細說明
主題。大部分主題都是 Bazel 指令,例如 build
或 query
,但也有一些與指令不相符的其他說明主題。
--[no]long
(-l
)
根據預設,bazel help [topic]
只會輸出
主題相關選項的摘要。如果指定 --long
選項,則會一併列印每個選項的類型、預設值和完整說明。
shutdown
您可以使用 shutdown
指令停止 Bazel 伺服器程序。這個指令會讓 Bazel 伺服器在執行時立即結束
會變為閒置 (例如,在完成任何版本或
指令中的指令)。詳情請參閱「用戶端/伺服器導入」。
Bazel 伺服器會在閒置逾時後自行停止,因此這個指令 很少需要但如果使用指令碼 已知特定工作區不會再發生任何建構作業。
shutdown
接受一個選項 --iff_heap_size_greater_than _n_
,需要整數引數 (以 MB 為單位)。如有指定,則會關閉
不超過已使用的記憶體數量。這是
很適合用於啟動大量建構作業的指令碼
Bazel 伺服器中的流失問題可能會導致叢集在
執行條件式重新啟動便會先佔此條件
info
info
指令會列印與 Bazel 伺服器執行個體或特定建構設定相關聯的各種值。(用於驅動建構的指令碼可能會使用這些內容)。
info
指令也允許一個 (選用)
引數,也就是下方清單中其中一個鍵的名稱。
在此情況下,bazel info key
只會列印
就會產生該鍵的值(在編寫 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 上傳資料集之後,您可以運用 AutoML 自動完成部分資料準備工作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-*
符號連結相同。不過,如果 workspace 目錄是唯讀狀態 無法建立bazel-*
符號連結。使用bazel info
回報的值,而非假設存在符號連結的腳本,會更為穩健。- 完整
「廠牌」環境。如果指定
--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
版本指令會顯示已建構 Bazel 的版本詳細資料 二進位檔案,包括建立時所在的變更清單和日期。 因此在判斷您是否 Bazel,或者您在回報錯誤時其中一些有趣的值包括:
changelist
:這個版本的 Bazel 發布時的變更清單。label
:這個 Bazel 的發布標籤 執行個體,或稱「開發版本」如未推出 二進位檔案。這項功能非常實用,
bazel --version
在沒有其他引數的情況下,會產生與 bazel version --gnu_format
相同的輸出內容,但不會產生可能啟動 Bazel 伺服器或解開伺服器封存檔的副作用。bazel --version
的執行來源
而且不需要工作區目錄
mobile-install
mobile-install
指令會將應用程式安裝至行動裝置。
目前僅支援搭載 ART 的 Android 裝置。
詳情請參閱 bazel 行動安裝。
支援下列選項:
--incremental
如果已設定,Bazel 會嘗試以增量方式安裝應用程式,也就是只安裝上次建構後變更的部分。無法更新資源
從 AndroidManifest.xml
、原生程式碼或 Java 參照
存取這些資源 (例如 Class.getResource()
參照的資源)。如果這些
所以請務必省略這個選項與 Bazel 的精神相反,且由於 Android 平台的限制,使用者有責任瞭解何時該使用這項指令,以及何時需要完整安裝。
如果您使用的是 Marshmallow 以上版本的裝置,請考慮使用 --split_apks
旗標。
--split_apks
是否使用分割 APK 來安裝及更新裝置上的應用程式。
僅適用於搭載 Marshmallow 以上版本的裝置。請注意,使用 --split_apks
時,不需要 --incremental
旗標。
--start_app
在安裝後以乾淨狀態啟動應用程式。等同於 --start=COLD
。
--debug_app
等待偵錯工具附加完成,才能在安裝完成後啟動應用程式。
等同於 --start=DEBUG
。
--start=_start_type_
應用程式安裝後應如何啟動。支援的 _start_type_ 有:
NO
未啟動應用程式。此為預設值。COLD
在安裝後從乾淨狀態啟動應用程式。WARM
在漸進式安裝作業中保留及還原應用程式狀態。DEBUG
在安裝後,等待偵錯工具,再以乾淨狀態啟動應用程式。
--adb=path
指出要使用的 adb
二進位檔。
系統預設會使用
--android_sdk
。
--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 伺服器的內部狀態。這個指令主要供 Bazel 開發人員使用,因此不會指定這個指令的輸出內容,且可能隨時變更。
根據預設,指令只會輸出說明訊息 可轉儲 Bazel 狀態的特定區域如要轉儲內部狀態,至少必須指定一個選項。
支援下列選項:
--action_cache
會傾印動作快取內容。--packages
會轉儲套件快取內容。--skyframe
會傾印內部 Bazel 依附元件圖的狀態。--rules
會為每個規則和切面類別傾印規則摘要, 包括計數和操作次數包括原生和 Starlark 規則。如果已啟用記憶體追蹤以及記憶體用量--skylark_memory
轉儲 a 將 .gz 檔案與 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 --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 指令的選項清單,並傳回具有相同效果的選項清單。新的選項清單為標準網址。例如:
具有相同效果的兩個選項清單,會標準化為相同的新清單。
--for_command
選項可用於選取不同的指令。目前僅支援 build
和 test
。指定指令不支援的選項會造成錯誤。
舉例來說:
% bazel canonicalize-flags -- --config=any_name --test_tag_filters="-lint" --config=any_name --test_tag_filters=-lint
啟動選項
本節說明的選項會影響 Java 的啟動程序 而且 Bazel 伺服器程序使用的虛擬機器 該伺服器處理的後續指令如果已有 且啟動選項不相符
您必須使用 --key=value
或 --key value
語法指定本節所述的所有選項。此外,這些選項必須出現在 Bazel 指令名稱的前面。使用 startup --key=value
在 .bazelrc
檔案中列出這些項目。
--output_base=dir
這個選項需要路徑引數,且必須指定可寫入的目錄。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
在這項指令中,兩個 Bazel 指令會同時執行 (因為有殼 &
運算子),每個指令都會使用不同的 Bazel 伺服器執行個體 (因為有不同的輸出基礎)。相反地,如果兩個指令都使用預設輸出基底,則兩個要求都會傳送至同一台伺服器,而伺服器會依序處理這些要求:先建構 //foo
,再進行 //bar
的增量建構作業。
--output_user_root=dir
指向建立輸出內容和安裝基礎的根目錄。目錄必須不存在,或是由呼叫使用者擁有。過去 此權限允許指向多位使用者共用的目錄 但不再允許這允許這個方法一次 問題 #11100 已解決。
如果指定 --output_base
選項,系統會覆寫這項設定
並使用 --output_user_root
計算輸出底數。
系統會根據 --output_user_root
和 Bazel 嵌入式二進位檔的 MD5 身分,計算安裝基地位置。
如果檔案系統版面配置中有更適合的路徑,您可以使用 --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 虛擬機器的啟動選項 或任何可執行 Knative 的環境中這可用來設定堆疊大小,例如:
% bazel --host_jvm_args="-Xss256K" build //foo
這個選項可搭配個別引數使用多次。請注意,您很少需要設定這個旗標。您也可以傳遞以空格分隔的字串清單,每個字串都會解讀為個別的 JVM 引數,但這項功能很快就會淘汰。
這項變更「不會」影響 Bazel 子程序 (應用程式、測試、工具等) 使用的任何 JVM。如要將 JVM 選項傳遞至可執行的 Java 程式,無論是透過 bazel
run
或指令列執行,您都應使用所有 java_binary
和 java_test
程式支援的 --jvm_flags
引數。或者,您也可以使用 bazel test --test_arg=--jvm_flags=foo ...
進行測試。
--host_jvm_debug
這個選項會讓 Java 虛擬機器在呼叫 Bazel 本身的主方法前,等待 JDWP 相容偵錯工具的連線。這項功能主要供 Bazel 開發人員使用。
--autodetect_server_javabase
這個選項會使 Bazel 在啟動時自動搜尋已安裝的 JDK。
,如果無法使用內嵌的 JRE,即可改回使用已安裝的 JRE。
--explicit_server_javabase
可用於挑選明確的 JRE,以用於
以及如何執行 Bazel
--batch
批次模式會導致 Bazel 不使用 標準用戶端/伺服器模式,但會改為執行 Terraform 適用於單一指令的 Java 程序,因為這個程序較能預測 信號處理、工作控制和環境的相關語意 變數繼承,在 Chroot 監獄中執行 bazel 是必要的。
批次模式會在相同的 output_base 中保留適當的排隊語意。也就是說,系統會依序處理同時叫用,不會重疊。若是批次模式 Bazel 在執行中伺服器的用戶端上執行, 在處理指令前終止伺服器
Bazel 在批次模式下或上述替代方案執行時,執行速度會較慢。 這是因為建構檔案快取會佔用記憶體, 而保留不變 因此,在需要注意效能的情況下,使用批次模式通常更有意義 重要性較低,例如持續建構
--max_idle_secs=n
這個選項會指定 Bazel 伺服器程序在最後一個用戶端要求後,應等待多久 (以秒為單位) 才會結束。
預設值為 10800 (3 小時)。--max_idle_secs=0
會導致 Bazel 伺服器程序無限期持續運作。
這個選項可供叫用 Bazel 的指令碼使用,以確保在 Bazel 伺服器程序不會執行時,不會在使用者的電腦上保留這些程序。舉例來說,預先提交的指令碼可能會為了
叫用 bazel query
,以確保使用者的待處理狀態
變更不會產生不必要的依附性不過,
使用者最近未在該工作區中使用過新版本
並不適合透過預先提交指令碼啟動 Bazel 伺服器
讓它在一整天內都處於閒置狀態
在查詢要求中指定較小的 --max_idle_secs
值,指令碼就能確保如果導致新伺服器啟動,該伺服器會立即結束,但如果已經有伺服器在執行,該伺服器會繼續執行,直到閒置時間達到平常的時間為止。當然,現有伺服器的閒置計時器也會重設。
--[no]shutdown_on_low_sys_mem
如果啟用此選項,並將 --max_idle_secs
設為正值時間長度,系統會在記憶體不足時,關閉閒置一段時間後的建構伺服器。僅適用於 Linux。
除了執行與 max_idle_secs 相對應的閒置檢查之外,建構伺服器還會 在伺服器閒置一段時間後,開始監控可用系統記憶體。 如果可用的系統記憶體嚴重不足,伺服器就會結束。
--[no]block_for_lock
如果啟用,Bazel 會等待其他持有伺服器鎖定的 Bazel 指令完成,再繼續進行。如果停用,如果 Bazel 無法立即取得鎖定並繼續執行,就會退出錯誤。
開發人員可能可以在預先提交檢查時使用,避免長時間等候 相同用戶端中的另一個 Bazel 指令
--io_nice_level=n
設定最佳努力 I/O 排程的等級 (0 到 7)。0 為最高優先順序,7 為最低優先順序。預測排程器最多只會執行優先順序 4 的工作。系統會忽略負值。
--batch_cpu_scheduling
請為 Bazel 使用 batch
CPU 排程功能。這項政策適合用於
不具有互動性,但不想降低價值。
請參閱「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
中提取選項。可以是
從數個設定部分新增旗標展開項目可以參照其他定義 (例如展開項目可以連結)。
--curses (yes|no|auto)
這個選項會決定 Bazel 是否會在螢幕輸出內容中使用游標控制項。這會減少捲動資料,並提供更精簡、易讀的 Bazel 輸出串流。這項做法與 --color
搭配得很好。
如果將這個選項設為 yes
,則會啟用遊標控制項。
如果將這個選項設為 no
,則會停用遊標控制項。
如果這個選項設為 auto
,系統會在與 --color=auto
相同的條件下啟用游標控制項。
--[no]show_timestamps
如有指定,系統就會為由 SDK 產生的每則訊息加上時間戳記 Bazel 用於指定訊息顯示時間。