Menulis file konfigurasi bazelrc

Laporkan masalah Lihat sumber Nightly · 7.4 .

Bazel menerima banyak opsi. Beberapa opsi sering kali bervariasi (misalnya, --subcommands) sementara opsi lainnya tetap sama di beberapa build (seperti --package_path). Untuk menghindari penentuan 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 ditampilkan di bawah. Opsi ditafsirkan dalam urutan ini, sehingga opsi dalam file berikutnya dapat menggantikan nilai dari file sebelumnya jika terjadi konflik. Semua opsi yang mengontrol file mana yang dimuat adalah opsi startup, yang berarti opsi tersebut harus terjadi setelah bazel dan sebelum perintah (build, test, dll.).

  1. File RC sistem, kecuali jika --nosystem_rc ada.

    Lokasi:

    • Di Linux/macOS/Unix: /etc/bazel.bazelrc
    • Pada Windows: %ProgramData%\bazel.bazelrc

    Tidak ada error jika file ini tidak ada.

    Jika lokasi lain yang ditentukan sistem diperlukan, Anda harus mem-build biner Bazel kustom, yang mengganti nilai BAZEL_SYSTEM_BAZELRC_PATH di //src/main/cpp:option_processor. Lokasi yang ditentukan sistem dapat berisi referensi variabel lingkungan, seperti ${VAR_NAME} di Unix atau %VAR_NAME% di Windows.

  2. File RC ruang kerja, kecuali jika --noworkspace_rc ada.

    Jalur: .bazelrc di direktori ruang kerja Anda (di samping file MODULE.bazel utama).

    Bukan suatu error jika file ini tidak ada.

  3. File RC home, kecuali jika --nohome_rc ada.

    Lokasi:

    • Di Linux/macOS/Unix: $HOME/.bazelrc
    • Di Windows: %USERPROFILE%\.bazelrc jika ada, atau %HOME%/.bazelrc

    Bukan suatu error jika file ini tidak ada.

  4. File RC yang ditentukan pengguna, jika ditentukan dengan --bazelrc=file

    Tanda ini bersifat opsional tetapi juga dapat ditentukan beberapa kali.

    /dev/null menunjukkan bahwa semua --bazelrc lebih lanjut 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 dan y.rc sudah dibaca.
    • z.rc diabaikan karena /dev/null sebelumnya.

Selain file konfigurasi opsional ini, Bazel akan mencari file rc global. Untuk mengetahui 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 ditokenisasi sesuai dengan 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 demikian untuk file 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 dalam 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 di bazel help startup_options.
  • common: opsi yang harus diterapkan pada semua perintah Bazel yang mendukungnya. Jika perintah tidak mendukung opsi yang ditentukan dengan cara ini, opsi akan diabaikan selama opsi tersebut valid untuk beberapa perintah Bazel lainnya. Perhatikan bahwa hal ini hanya berlaku untuk nama opsi: Jika perintah saat ini menerima opsi dengan nama yang ditentukan, tetapi tidak mendukung nilai yang ditentukan, perintah akan gagal.
  • always: opsi yang berlaku untuk semua perintah Bazel. Jika perintah tidak mendukung opsi yang ditentukan dengan cara ini, perintah akan gagal.
  • command: Perintah Bazel, seperti build atau query yang menerapkan opsi. Opsi ini juga berlaku untuk semua perintah yang diturunkan dari perintah yang ditentukan. (Misalnya, test mewarisi dari build.)

Setiap baris ini dapat digunakan lebih dari sekali dan argumen yang mengikuti kata pertama digabungkan seolah-olah muncul di 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 di command line selalu diutamakan daripada opsi dalam file rc. Misalnya, jika file rc menyatakan build -c opt, tetapi tanda command line adalah -c dbg, tanda command line akan lebih diprioritaskan.

  • Dalam file rc, prioritas diatur oleh kekhususan: baris untuk perintah yang lebih spesifik lebih diutamakan daripada baris untuk perintah yang kurang spesifik.

    Spesifitas ditentukan oleh pewarisan. Beberapa perintah mewarisi opsi dari perintah lain, sehingga perintah pewarisan menjadi lebih spesifik daripada perintah dasar. Misalnya, test mewarisi dari perintah build, sehingga semua flag bazel build valid untuk bazel test, dan semua baris build juga berlaku untuk bazel test, kecuali jika ada baris test untuk opsi yang sama. Jika file rc mengatakan:

    test -c dbg --test_env=PATH
build -c opt --verbose_failures

    maka bazel build //foo akan menggunakan -c opt --verbose_failures, dan bazel test //foo akan menggunakan --verbose_failures -c dbg --test_env=PATH.

    Grafik pewarisan (kekhususan) adalah:

    • Setiap perintah diwarisi dari common
    • Perintah berikut mewarisi dari (dan lebih spesifik daripada) build: test, run, clean, mobile-install, info, print_action, config, cquery, dan aquery
    • coverage, fetch, dan vendor mewarisi dari test

  • Dua baris yang menentukan opsi untuk perintah yang sama dengan kekhususan yang sama akan diuraikan sesuai urutan kemunculan dalam file.

  • Karena aturan prioritas ini tidak cocok dengan urutan file, aturan ini akan membantu keterbacaan jika Anda mengikuti urutan prioritas dalam file rc: mulai dengan opsi common di bagian atas, dan akhiri dengan perintah yang paling spesifik di bagian bawah file. Dengan demikian, urutan opsi yang dibaca sama dengan urutan penerapannya, yang lebih intuitif.

Argumen yang ditentukan pada baris file rc dapat mencakup argumen yang bukan opsi, seperti nama target build, dan sebagainya. Argumen ini, seperti opsi yang ditentukan dalam file yang sama, memiliki prioritas lebih rendah daripada yang seinduknya pada command line, dan selalu ditambahkan ke daftar eksplisit argumen non-opsi.

--config

Selain menetapkan default opsi, file rc dapat digunakan untuk mengelompokkan opsi dan memberikan singkatan untuk pengelompokan umum. Hal ini dilakukan dengan menambahkan akhiran :name ke perintah. Opsi ini diabaikan secara default, tetapi akan disertakan saat 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 diperluas ke penggunaan startup untuk menetapkan opsi startup. Menetapkan startup:config-name --some_startup_option di .bazelrc akan diabaikan.

--enable_platform_specific_config

Konfigurasi khusus platform di .bazelrc dapat diaktifkan secara otomatis menggunakan --enable_platform_specific_config. Misalnya, jika OS host adalah Linux dan perintah build dijalankan, konfigurasi build:linux akan otomatis diaktifkan. ID OS yang didukung adalah linux, macos, windows, freebsd, dan openbsd. Mengaktifkan flag ini sama dengan menggunakan --config=linux di Linux, --config=windows di Windows, dan sebagainya.

Lihat --enable_platform_specific_config.

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 Anda abaikan oleh Bazel, seperti project terkait yang menggunakan sistem build lain. Tempatkan file bernama .bazelignore di root ruang kerja dan tambahkan direktori yang ingin diabaikan Bazel, satu per baris. Entri bersifat relatif terhadap root ruang kerja.

File bazelrc global

Bazel membaca file bazelrc opsional dalam urutan ini:

  1. File rc sistem terletak di etc/bazel.bazelrc.
  2. File rc Workspace yang terletak di $workspace/tools/bazel.rc.
  3. File rc rumah terletak di $HOME/.bazelrc

Setiap file bazelrc yang tercantum di sini memiliki flag 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.