Ruang kerja, paket, dan target

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

Workspace

Ruang kerja adalah hierarki direktori pada 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 dari ruang kerja. Oleh karena itu, Bazel mengabaikan setiap hierarki direktori di ruang kerja yang di-root pada subdirektori yang berisi file WORKSPACE, karena hierarki tersebut membentuk ruang kerja lain.

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

Repositori

Kode diatur di repositori. Direktori yang berisi file WORKSPACE adalah root dari repositori utama, yang juga disebut @. Repositori (eksternal) lainnya ditentukan dalam file WORKSPACE menggunakan aturan ruang kerja.

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

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

Paket

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

Paket didefinisikan sebagai direktori yang berisi file bernama BUILD (atau BUILD.bazel). Paket mencakup semua file dalam direktorinya, plus semua subdirektori di bawahnya, kecuali yang berisi file BUILD. Dari definisi ini, tidak ada file atau direktori yang mungkin merupakan bagian dari dua paket yang berbeda.

Misalnya, dalam hierarki direktori berikut, ada dua paket, my/app, dan my/app/tests sub-paket. Perhatikan bahwa my/app/data bukan paket, melainkan direktori yang termasuk dalam 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 merupakan salah satu dari dua jenis utama, file dan aturan.

File dibagi lagi menjadi dua jenis. File sumber biasanya ditulis oleh upaya orang, dan dimasukkan 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 aturan lainnya.

Apakah input ke aturan adalah file sumber atau file yang dihasilkan dalam sebagian besar kasus bersifat tidak penting; yang penting hanya konten file tersebut. Fakta ini memudahkan penggantian file sumber yang kompleks dengan file yang dihasilkan yang dihasilkan oleh suatu aturan, seperti yang terjadi saat beban mengelola file yang sangat terstruktur secara manual menjadi terlalu melelahkan, dan seseorang menulis program untuk mendapatkannya. Konsumen file tersebut tidak perlu melakukan perubahan apa pun. Sebaliknya, file yang dihasilkan dapat dengan mudah diganti dengan file sumber dengan perubahan lokal saja.

Input ke aturan juga dapat menyertakan aturan lain. Makna tepat dari hubungan tersebut sering kali cukup kompleks dan bergantung pada bahasa atau aturan, tetapi secara intuitif, semuanya sederhana: aturan library C++ A mungkin memiliki aturan library C++ B 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 berada dalam paket yang sama dengan aturan itu sendiri; membuat file tidak dapat dibuat ke paket lain. Tidak jarang input aturan berasal dari paket lain.

Grup paket adalah kumpulan paket yang tujuannya adalah untuk membatasi aksesibilitas aturan tertentu. Grup paket ditentukan oleh fungsi package_group. Class ini memiliki tiga properti: daftar paket yang ada di dalamnya, namanya, dan grup paket lain yang disertakan. Satu-satunya cara yang diizinkan untuk merujuknya adalah dari atribut visibility aturan atau dari atribut default_visibility fungsi package; cara ini tidak menghasilkan atau memakai file. Untuk informasi selengkapnya, lihat dokumentasi package_group.

Label