Ruang kerja, paket, dan target

Laporkan masalah Lihat sumber Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel mem-build software dari kode sumber yang diatur dalam hierarki direktori yang disebut 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 dibuat dari sumber.

Workspace

Ruang kerja adalah hierarki direktori pada sistem file yang berisi file sumber untuk software yang ingin Anda bangun. Setiap ruang kerja memiliki file teks bernama WORKSPACE yang mungkin kosong, atau mungkin berisi referensi ke dependensi eksternal yang diperlukan untuk mem-build 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 berakar di subdirektori yang berisi file WORKSPACE, karena membentuk ruang kerja lain.

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

Repositori

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

Aturan ruang kerja yang dipaketkan dengan Bazel didokumentasikan di bagian Aturan Workspace di 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 diabaikan oleh Bazel. Secara khusus, repositori yang bergantung secara transitif tidak ditambahkan secara otomatis.

Paket

Unit utama organisasi kode dalam repositori adalah paket. 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, serta semua subdirektori di bawahnya, kecuali yang berisi file BUILD. Dari definisi ini, tidak ada file atau direktori yang dapat menjadi bagian dari dua paket yang berbeda.

Misalnya, dalam hierarki direktori berikut, ada dua paket, my/app, dan subpaket my/app/tests. Perhatikan bahwa my/app/data bukan paket, tetapi 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

Target

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

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

Dalam sebagian besar kasus, apakah input ke aturan adalah file sumber atau file yang dihasilkan tidak penting; yang penting hanyalah konten file tersebut. Fakta ini memudahkan penggantian file sumber yang kompleks dengan file yang dihasilkan oleh aturan, seperti yang terjadi saat beban pemeliharaan file yang sangat terstruktur secara manual menjadi terlalu melelahkan, dan seseorang menulis program untuk mendapatkannya. Tidak ada perubahan yang diperlukan untuk konsumen file tersebut. Sebaliknya, file yang dihasilkan dapat dengan mudah diganti oleh file sumber hanya dengan perubahan lokal.

Input ke aturan juga dapat mencakup aturan lain. Makna yang tepat dari hubungan tersebut sering kali cukup kompleks dan bergantung pada bahasa atau aturan, tetapi secara intuitif, hal ini 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 bahwa file yang dihasilkan oleh aturan selalu termasuk dalam paket yang sama dengan aturan itu sendiri; tidak mungkin membuat file ke dalam paket lain. Namun, input aturan biasanya berasal dari paket lain.

Grup paket adalah kumpulan paket yang tujuannya adalah untuk membatasi aksesibilitas aturan tertentu. Grup paket ditentukan oleh fungsi package_group. Properti tersebut memiliki tiga properti: daftar paket yang ada di dalamnya, namanya, 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; cara tersebut tidak membuat atau menggunakan file. Untuk informasi selengkapnya, lihat dokumentasi package_group.

Label