Ruang kerja, paket, dan target

Laporkan masalah Lihat sumber

Bazel mem-build software dari kode sumber yang disusun dalam hierarki direktori bernama ruang kerja. File sumber di ruang kerja diatur dalam hierarki paket bertingkat, dengan setiap paket adalah direktori yang berisi kumpulan file sumber terkait dan satu file BUILD. File BUILD menentukan output software yang dapat di-build dari sumber.

Workspace

Ruang kerja adalah hierarki direktori di sistem file yang berisi file sumber untuk software yang ingin Anda build. Setiap ruang kerja memiliki file teks bernama WORKSPACE yang mungkin kosong, atau mungkin berisi referensi ke dependensi eksternal yang diperlukan untuk membuat output.

Direktori yang berisi file bernama WORKSPACE dianggap sebagai root ruang kerja. Oleh karena itu, Bazel mengabaikan hierarki direktori apa pun di ruang kerja yang di-root di subdirektori yang berisi file WORKSPACE, karena pohon tersebut membentuk ruang kerja lain.

Bazel juga mendukung file WORKSPACE.bazel sebagai alias file WORKSPACE. Jika kedua file ada, WORKSPACE.bazel akan digunakan.

Repositories

Kode dikelola di repositori. Direktori yang berisi file WORKSPACE adalah root repositori utama, yang juga disebut @. Repositori lain (eksternal) ditentukan dalam file WORKSPACE menggunakan aturan ruang kerja, atau dibuat dari modul dan ekstensi dalam sistem Bzlmod. Lihat ringkasan dependensi eksternal untuk informasi selengkapnya.

Aturan ruang kerja yang dipaketkan dengan Bazel didokumentasikan dalam bagian Aturan Workspace di Build Encyclopedia dan dokumentasi tentang aturan repositori Starlark yang disematkan.

Karena repositori eksternal adalah repositori itu sendiri, repositori sering kali juga berisi file WORKSPACE. Namun, file WORKSPACE tambahan ini diabaikan oleh Bazel. Secara khusus, repositori yang bergantung pada secara transitif tidak ditambahkan secara otomatis.

Paket

Unit utama organisasi kode dalam repositori adalah paket. Paket adalah kumpulan file terkait dan spesifikasi tentang cara penggunaannya untuk menghasilkan artefak output.

Paket didefinisikan sebagai direktori yang berisi file BUILD yang bernama BUILD atau BUILD.bazel. Paket mencakup semua file dalam direktorinya, ditambah semua subdirektori di bawahnya, kecuali yang berisi file BUILD. Dari definisi ini, tidak ada file atau direktori yang dapat menjadi bagian dari dua paket berbeda.

Misalnya, dalam hierarki direktori berikut, terdapat dua paket, my/app, dan subpaket my/app/tests. Perlu diketahui bahwa my/app/data bukanlah paket, melainkan direktori milik paket my/app.

src/my/app/BUILD
src/my/app/app.cc
src/my/app/data/input.txt
src/my/app/tests/BUILD
src/my/app/tests/test.cc

Targets

Paket adalah penampung target, yang ditentukan dalam file BUILD paket. Sebagian besar target adalah salah satu dari dua jenis utama, yaitu file dan aturan.

Selanjutnya file dibagi menjadi dua jenis. File sumber biasanya ditulis oleh upaya orang, dan di-check in ke repositori. File yang dihasilkan, terkadang disebut file turunan atau file output, tidak di-check in, tetapi dihasilkan dari file sumber.

Jenis target kedua dideklarasikan dengan aturan. Setiap instance aturan menentukan hubungan antara kumpulan input dan kumpulan file output. Input ke aturan dapat berupa file sumber, tetapi juga dapat berupa output dari aturan lainnya.

Baik input ke aturan adalah file sumber atau file yang dihasilkan, pada umumnya tidak penting; yang terpenting hanyalah isi file tersebut. Fakta ini memudahkan penggantian file sumber yang kompleks dengan file yang dihasilkan dan dihasilkan oleh aturan, seperti ketika beban pemeliharaan file yang sangat terstruktur secara manual menjadi terlalu melelahkan, dan seseorang menulis program untuk mendapatkannya. Pengguna tidak perlu melakukan perubahan apa pun. Sebaliknya, file yang dihasilkan dapat dengan mudah diganti dengan file sumber hanya dengan perubahan lokal.

Input ke aturan juga dapat menyertakan aturan lain. Makna yang tepat dari hubungan tersebut sering kali sangat kompleks dan bergantung pada bahasa atau aturan, tetapi secara intuitif ini sederhana: aturan library C++ A mungkin memiliki aturan library C++ lain untuk input. Efek dari dependensi ini adalah file header B tersedia untuk A selama kompilasi, simbol B tersedia untuk A selama penautan, dan data runtime B tersedia untuk A selama eksekusi.

Invarian dari semua aturan adalah file yang dihasilkan oleh aturan selalu menjadi bagian dari paket yang sama dengan aturan itu sendiri; file tidak dapat dibuat menjadi paket lain. Namun, tidak jarang input aturan berasal dari paket lain.

Grup paket adalah sekumpulan paket yang bertujuan untuk membatasi aksesibilitas aturan tertentu. Grup paket ditentukan oleh fungsi package_group. Mereka memiliki tiga properti: daftar paket yang ada di dalamnya, nama mereka, dan grup paket lainnya yang disertakan. Satu-satunya cara yang diizinkan untuk merujuknya adalah dari atribut visibility aturan atau dari atribut default_visibility fungsi package; atribut tersebut tidak menghasilkan atau menggunakan file. Untuk informasi selengkapnya, lihat dokumentasi package_group.

Label