Bazel menerima banyak opsi. Beberapa opsi sering bervariasi (misalnya,
--subcommands
), sementara opsi lainnya tetap sama di beberapa build (seperti
--package_path
). Agar tidak menentukan opsi yang tidak berubah ini untuk setiap build
(dan perintah lainnya), Anda dapat menentukan opsi dalam file konfigurasi, yang disebut
.bazelrc
.
Di mana file .bazelrc
?
Bazel mencari file konfigurasi opsional di lokasi berikut,
dalam urutan yang ditunjukkan di bawah ini. Opsi ditafsirkan dalam urutan ini, sehingga
opsi di file berikutnya dapat mengganti nilai dari file sebelumnya jika
terjadi konflik. Semua opsi yang mengontrol file mana saja yang dimuat adalah
opsi startup, yang berarti opsi tersebut harus muncul setelah bazel
dan
sebelum perintah (build
, test
, dll).
File RC sistem, kecuali jika
--nosystem_rc
ada.Lokasi:
- Di Linux/macOS/Unixes:
/etc/bazel.bazelrc
- Pada Windows:
%ProgramData%\bazel.bazelrc
Bukan merupakan error jika file ini tidak ada.
Jika lokasi lain yang ditentukan sistem diperlukan, Anda harus membuat biner Bazel kustom, yang menggantikan nilai
BAZEL_SYSTEM_BAZELRC_PATH
dalam//src/main/cpp:option_processor
. Lokasi yang ditentukan sistem dapat berisi referensi variabel lingkungan, seperti${VAR_NAME}
pada Unix atau%VAR_NAME%
pada Windows.- Di Linux/macOS/Unixes:
File RC Workspace, kecuali jika
--noworkspace_rc
ada.Jalur:
.bazelrc
di direktori ruang kerja Anda (di samping fileWORKSPACE
utama).Bukan merupakan error jika file ini tidak ada.
File RC beranda, kecuali jika
--nohome_rc
ada.Lokasi:
- Di Linux/macOS/Unixes:
$HOME/.bazelrc
- Di Windows:
%USERPROFILE%\.bazelrc
jika ada, atau%HOME%/.bazelrc
Bukan merupakan error jika file ini tidak ada.
- Di Linux/macOS/Unixes:
File RC yang ditentukan pengguna, jika ditentukan dengan
--bazelrc=file
Penanda ini bersifat opsional, tetapi juga bisa ditentukan beberapa kali.
/dev/null
menunjukkan bahwa semua--bazelrc
berikutnya akan diabaikan, yang berguna untuk menonaktifkan penelusuran file rc pengguna, seperti dalam build rilis.Contoh:
--bazelrc=x.rc --bazelrc=y.rc --bazelrc=/dev/null --bazelrc=z.rc
x.rc
dany.rc
telah dibaca.z.rc
diabaikan karena/dev/null
sebelumnya.
Selain file konfigurasi opsional ini, Bazel akan mencari file rc global. Untuk detail selengkapnya, lihat bagian bazelrc global.
Sintaksis dan semantik .bazelrc
Seperti semua file "rc" UNIX, file .bazelrc
adalah file teks dengan tata bahasa
berbasis baris. Baris kosong dan baris yang dimulai dengan #
(komentar) akan diabaikan. Setiap baris berisi urutan kata, yang dibuatkan token sesuai aturan yang sama dengan shell Bourne.
Impor
Baris yang dimulai dengan import
atau try-import
bersifat khusus: gunakan baris ini untuk memuat
file "rc" lainnya. Untuk menentukan jalur yang relatif terhadap root ruang kerja, tulis import %workspace%/path/to/bazelrc
.
Perbedaan antara import
dan try-import
adalah Bazel akan gagal jika
file import
tidak ada (atau tidak dapat dibaca), tetapi tidak untuk file
yang memiliki try-import
.
Prioritas impor:
- Opsi dalam file yang diimpor lebih diutamakan daripada opsi yang ditentukan sebelum pernyataan impor.
- Opsi yang ditentukan setelah pernyataan impor lebih diutamakan daripada opsi dalam file yang diimpor.
- Opsi pada file yang diimpor nanti lebih diutamakan daripada file yang diimpor sebelumnya.
Opsi default
Sebagian besar baris bazelrc menentukan nilai opsi default. Kata pertama di setiap baris menentukan kapan default ini diterapkan:
startup
: opsi startup, yang berada sebelum perintah, dan dijelaskan dalambazel help startup_options
.common
: opsi yang berlaku untuk semua perintah Bazel.command
: Perintah Bazel, sepertibuild
atauquery
tempat opsi diterapkan. Opsi ini juga berlaku untuk semua perintah yang mewarisi dari perintah yang ditentukan. (Misalnya,test
mewarisi daribuild
.)
Setiap baris ini dapat digunakan lebih dari sekali dan argumen yang mengikuti
kata pertama digabungkan seolah-olah muncul dalam satu baris. (Pengguna CVS,
alat lain dengan antarmuka command line "Swiss army knife", akan menemukan
sintaksis yang mirip dengan .cvsrc
.) Misalnya, baris:
build --test_tmpdir=/tmp/foo --verbose_failures
build --test_tmpdir=/tmp/bar
digabungkan sebagai:
build --test_tmpdir=/tmp/foo --verbose_failures --test_tmpdir=/tmp/bar
sehingga flag yang efektif adalah --verbose_failures
dan --test_tmpdir=/tmp/bar
.
Prioritas opsi:
- Opsi pada command line selalu lebih diutamakan daripada opsi dalam file rc.
Misalnya, jika file rc menyatakan
build -c opt
, tetapi tanda command line-nya adalah-c dbg
, tanda command line akan lebih diutamakan. Dalam file rc, prioritas diatur oleh kekhususan: baris untuk perintah yang lebih spesifik lebih diutamakan daripada baris untuk perintah yang kurang spesifik.
Kekhususan didefinisikan oleh pewarisan. Beberapa perintah mewarisi opsi dari perintah lain, sehingga perintah pewarisan lebih spesifik daripada perintah dasar. Misalnya,
test
mewarisi dari perintahbuild
sehingga semua tandabazel build
valid untukbazel test
, dan semua barisbuild
juga berlaku untukbazel test
kecuali jika ada baristest
untuk opsi yang sama. Jika file rc mengatakan:test -c dbg --test_env=PATH
build -c opt --verbose_failures
bazel build //foo
akan menggunakan-c opt --verbose_failures
, danbazel test //foo
akan menggunakan--verbose_failures -c dbg --test_env=PATH
.Grafik pewarisan (kekhususan) adalah:
- Setiap perintah mewarisi dari
common
- Perintah berikut mewarisi dari (dan lebih spesifik daripada)
build
:test
,run
,clean
,mobile-install
,info
,print_action
,config
,cquery
, danaquery
coverage
mewarisi daritest
- Setiap perintah mewarisi dari
Dua baris yang menentukan opsi untuk perintah yang sama dengan kekhususan yang sama diurai sesuai urutan kemunculannya dalam file.
Karena aturan prioritas ini tidak cocok dengan urutan file, hal ini membantu keterbacaan jika Anda mengikuti urutan prioritas dalam file rc: dimulai dengan opsi
common
di bagian atas, dan diakhiri dengan perintah paling spesifik di bagian bawah file. Dengan cara ini, urutan opsi dibaca sama dengan urutan penerapannya, yaitu lebih intuitif.
Argumen yang ditentukan pada baris file rc dapat menyertakan argumen yang bukan opsi, seperti nama target build, dan seterusnya. Ini, seperti opsi yang ditentukan dalam file yang sama, memiliki prioritas lebih rendah daripada pasangannya pada command line, dan selalu ditambahkan ke daftar eksplisit argumen non-opsi.
--config
Selain menyetel opsi default, file rc dapat digunakan untuk mengelompokkan opsi
dan memberikan singkatan untuk pengelompokan umum. Hal ini dilakukan dengan menambahkan
akhiran :name
pada perintah. Opsi ini diabaikan secara default, tetapi akan
disertakan jika opsi --config=name
ada,
baik pada command line maupun dalam file .bazelrc
, secara rekursif, bahkan di dalam
definisi konfigurasi lainnya. Opsi yang ditentukan oleh command:name
hanya akan
diperluas untuk perintah yang berlaku, dalam urutan prioritas yang dijelaskan di atas.
--config=foo
diperluas ke opsi yang ditentukan dalam
file rc "di tempat" sehingga opsi
yang ditentukan untuk konfigurasi memiliki prioritas yang sama dengan
opsi --config=foo
.
Sintaksis ini tidak mencakup penggunaan startup
untuk menetapkan
opsi startup. Menetapkan
startup:config-name --some_startup_option
dalam file .bazelrc akan diabaikan.
Contoh
Berikut adalah contoh file ~/.bazelrc
:
# Bob's Bazel option defaults
startup --host_jvm_args=-XX:-UseParallelGC
import /home/bobs_project/bazelrc
build --show_timestamps --keep_going --jobs 600
build --color=yes
query --keep_going
# Definition of --config=memcheck
build:memcheck --strip=never --test_timeout=3600
File lain yang mengatur perilaku Bazel
.bazelignore
Anda dapat menentukan direktori dalam ruang kerja
yang ingin diabaikan oleh Bazel, seperti project terkait
yang menggunakan sistem build lain. Tempatkan file bernama
.bazelignore
di root ruang kerja
dan tambahkan direktori yang Anda ingin abaikan oleh Bazel, satu per
baris. Entri berhubungan dengan root ruang kerja.
File bazelrc global
Bazel membaca file bazelrc opsional dalam urutan ini:
- File rc-sistem yang berada di etc/bazel.bazelrc
.
- File rc Workspace yang berada di $workspace/tools/bazel.rc
.
- File rc-home yang dilokalkan di $HOME/.bazelrc
Setiap file bazelrc yang tercantum di sini memiliki tanda yang sesuai yang dapat digunakan untuk menonaktifkannya (misalnya --nosystem_rc
, --noworkspace_rc
, --nohome_rc
). Anda juga dapat membuat Bazel mengabaikan semua bazelrc dengan meneruskan opsi startup --ignore_all_rc_files
.