Çalışma alanları, paketler ve hedefler

Sorun bildirme Kaynağı görüntüleme Nightly · 7.4 . 7.3 · 7.2 · 7.1 · 7.0 · 6.5

Bazel, yazılımları çalışma alanı adı verilen bir dizin ağacında düzenlenen kaynak koddan oluşturur. Çalışma alanındaki kaynak dosyalar, paketlerden oluşan iç içe yerleştirilmiş bir hiyerarşide düzenlenir. Her paket, bir dizi ilgili kaynak dosya ve bir BUILD dosyası içeren bir dizindir. BUILD dosyası, kaynaktan hangi yazılım çıkışlarının oluşturulabileceğini belirtir.

Çalışma alanı

Çalışma alanı, derlemek istediğiniz yazılımın kaynak dosyalarını içeren dosya sisteminizde bir dizin ağacıdır. Her çalışma alanında, WORKSPACE adlı bir metin dosyası bulunur. Bu dosya boş olabilir veya çıkışları oluşturmak için gereken harici bağımlılıklara referanslar içerebilir.

WORKSPACE adlı bir dosya içeren dizinler, bir çalışma alanının kökü olarak kabul edilir. Bu nedenle Bazel, başka bir çalışma alanı oluşturdukları için WORKSPACE dosyası içeren bir alt dizinde köklenen bir çalışma alanındaki tüm dizin ağaçlarını yoksayar.

Bazel, WORKSPACE.bazel dosyasını WORKSPACE dosyasının takma adı olarak da destekler. Her iki dosya da mevcutsa WORKSPACE.bazel kullanılır.

Kod depoları

Kodlar repositories düzenlenir. WORKSPACE dosyasını içeren dizin, @ olarak da adlandırılan ana deponun köküdür. Diğer (harici) depolar, WORKSPACE dosyasında Workspace kuralları kullanılarak tanımlanır veya Bzlmod sistemindeki modüllerden ve uzantılardan oluşturulur. Daha fazla bilgi için dış bağımlılıklara genel bakış bölümüne bakın.

Bazel ile birlikte sunulan çalışma alanı kuralları, Derleme Ansiklopedisi'ndeki Çalışma Alanı Kuralları bölümünde ve yerleşik Starlark depo kuralları ile ilgili belgelerde açıklanmıştır.

Harici depolar da depo olduğundan genellikle bir WORKSPACE dosyası da içerir. Ancak bu ek WORKSPACE dosyaları Bazel tarafından yoksayılır. Özellikle, geçişli olarak bağlı olan depolar otomatik olarak eklenmez.

Paketler

Bir depodaki kod organizasyonunun birincil birimi pakettir. Paket, ilgili dosyaların bir koleksiyonudur ve çıkış yapılarını oluşturmak için nasıl kullanılabileceklerine dair bir spesifikasyondur.

Paket, BUILD veya BUILD.bazel adlı bir BUILD dosyası içeren bir dizin olarak tanımlanır. Paket, dizinindeki tüm dosyaları ve altındaki tüm alt dizinleri (BUILD dosyası içerenler hariç) içerir. Bu tanım uyarınca, hiçbir dosya veya dizin iki farklı paketin parçası olamaz.

Örneğin, aşağıdaki dizin ağacında my/app ve my/app/tests alt paketi olmak üzere iki paket vardır. my/app/data'ün bir paket değil, my/app paketine ait bir dizin olduğunu unutmayın.

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

Hedefler

Paket, paketin BUILD dosyasında tanımlanan hedeflerin kapsayıcısıdır. Çoğu hedef, dosyalar ve kurallar olmak üzere iki ana türden biridir.

Dosyalar ayrıca iki türe ayrılır. Kaynak dosyalar genellikle kullanıcılar tarafından yazılır ve depoya kaydedilir. Bazen türetilmiş dosyalar veya çıkış dosyaları olarak da adlandırılan oluşturulan dosyalar, kontrol edilmez ancak kaynak dosyalardan oluşturulur.

İkinci hedef türü, bir kural ile tanımlanır. Her kural örneği, bir giriş dosyası grubu ile bir çıkış dosyası grubu arasındaki ilişkiyi belirtir. Kurala yapılan girişler kaynak dosyalar olabileceği gibi, diğer kuralların çıktıları da olabilir.

Bir kurala girilen girişin kaynak dosya mı yoksa oluşturulmuş dosya mı olduğu çoğu durumda önemli değildir. Önemli olan yalnızca bu dosyanın içeriğidir. Bu durum, karmaşık bir kaynak dosyanın, bir kural tarafından üretilen oluşturulmuş bir dosyayla değiştirilmesini kolaylaştırır. Örneğin, yüksek yapılandırılmış bir dosyayı manuel olarak yönetme yükü çok yorucu hale gelir ve biri bu dosyayı türetmek için bir program yazar. Bu dosyayı kullananlar için herhangi bir değişiklik gerekmez. Buna karşılık, oluşturulan bir dosya, yalnızca yerel değişiklikler içeren bir kaynak dosyayla kolayca değiştirilebilir.

Bir kuralın girişleri diğer kuralları da içerebilir. Bu tür ilişkilerin tam anlamı genellikle oldukça karmaşıktır ve dile veya kurala bağlıdır ancak sezgisel olarak basittir: A C++ kitaplığı kuralı, giriş için başka bir C++ kitaplığı kuralı B'ye sahip olabilir. Bu bağımlılığın etkisi, B'nin başlık dosyalarının derleme sırasında A tarafından, B'nin simgelerinin bağlantı sırasında A tarafından kullanılabilmesi ve B'nin çalışma zamanı verilerinin yürütme sırasında A tarafından kullanılabilmesidir.

Tüm kuralların değişmez bir özelliği, bir kural tarafından oluşturulan dosyaların her zaman kuralın kendisiyle aynı pakete ait olmasıdır. Başka bir pakette dosya oluşturmak mümkün değildir. Bununla birlikte, bir kuralın girişlerinin başka bir paketten gelmesi yaygın bir durumdur.

Paket grupları, belirli kuralların erişilebilirliğini sınırlandırmak amacıyla oluşturulan paket kümeleridir. Paket grupları, package_group işleviyle tanımlanır. Üç özelliği vardır: içerdikleri paketlerin listesi, adları ve içerdikleri diğer paket grupları. Bu işlevlere referans vermenin tek yolu, kuralların visibility özelliği veya package işlevinin default_visibility özelliğidir. Bu işlevler dosya oluşturmaz veya tüketmez. Daha fazla bilgi için package_group dokümanlarına bakın.

Etiketler