लेबल

किसी समस्या की शिकायत करें सोर्स देखें Nightly · 7.4 .

सभी टारगेट, सिर्फ़ एक पैकेज से जुड़े होते हैं. टारगेट के नाम को उसका लेबल कहा जाता है. हर लेबल किसी टारगेट की खास तौर पर पहचान करता है. कैननिकल फ़ॉर्मैट में, एक सामान्य लेबल ऐसा दिखता है:

@myrepo//my/app/main:app_binary

लेबल का पहला हिस्सा, डेटा स्टोर करने की जगह का नाम होता है, @myrepo//. अगर कोई लेबल उसी डेटा स्टोर करने की जगह को दिखाता है जिससे इसका इस्तेमाल किया जाता है, तो रिपॉज़िटरी आइडेंटिफ़ायर को // कहा जा सकता है. इसलिए, @myrepo में यह लेबल आम तौर पर इस तरह लिखा जाता है

//my/app/main:app_binary

लेबल का दूसरा हिस्सा, पैकेज का नाम my/app/main होता है. यह पैकेज का ऐसा नाम होता है जिसमें कोई विशेषता नहीं होती. यह नाम, रिपॉज़िटरी के रूट के हिसाब से पैकेज का पाथ होता है. डेटा स्टोर करने की जगह का नाम और अमान्य पैकेज के नाम, एक साथ पूरी तरह क्वालिफ़ाइड पैकेज का नाम @myrepo//my/app/main बनाते हैं. जब लेबल उसी पैकेज का रेफ़र करता है जिसमें उसका इस्तेमाल किया गया है, तो पैकेज का नाम (और वैकल्पिक रूप से, कोलन) छोड़ा जा सकता है. इसलिए, @myrepo//my/app/main में, यह लेबल इनमें से किसी भी तरीके से लिखा जा सकता है:

app_binary
:app_binary

आम तौर पर यह माना जाता है कि फ़ाइलों के लिए कोलन का इस्तेमाल नहीं किया जाता, लेकिन नियमों के हिसाब से इसे रखा जाता है, लेकिन यह अहम नहीं होता.

कोलन के बाद लेबल का जो हिस्सा है, app_binary वह टारगेट नाम नहीं है जिसे मंज़ूरी नहीं दी गई है. अगर यह पैकेज पाथ के आखिरी कॉम्पोनेंट से मेल खाता है, तो इसे और कोलन को छोड़ा जा सकता है. इसलिए, ये दो लेबल एक जैसे हैं:

//my/app/lib
//my/app/lib:lib

पैकेज की सबडायरेक्ट्री में, टारगेट की गई फ़ाइल का नाम, पैकेज रूट (BUILD फ़ाइल वाली डायरेक्ट्री) के हिसाब से फ़ाइल का पाथ होता है. इसलिए, यह फ़ाइल रिपॉज़िटरी की my/app/main/testdata सबडायरेक्ट्री में है:

//my/app/main:testdata/input.txt

//my/app और @some_repo//my/app जैसी स्ट्रिंग का मतलब, इस्तेमाल के कॉन्टेक्स्ट के हिसाब से दो तरह से होता है: जब Bazel को लेबल की ज़रूरत होती है, तो इनका मतलब क्रमशः //my/app:app और @some_repo//my/app:app होता है. हालांकि, जब Bazel को किसी पैकेज (उदाहरण के लिए, package_group स्पेसिफ़िकेशन में) की ज़रूरत होती है, तो वह उस पैकेज का रेफ़रंस देता है जिसमें वह लेबल मौजूद होता है.

BUILD फ़ाइलों में अक्सर यह गलती की जाती है कि किसी पैकेज या पैकेज के सभी टारगेट का रेफ़रंस देने के लिए, //my/app का इस्तेमाल किया जाता है. हालांकि, ऐसा नहीं करना चाहिए. याद रखें कि यह //my/app:app के बराबर है. इसलिए, यह मौजूदा रिपॉज़िटरी के my/app पैकेज में app टारगेट का नाम बताता है.

हालांकि, package_group या .bzl फ़ाइलों में, पैकेज के बारे में बताने के लिए //my/app का इस्तेमाल करने की सलाह दी जाती है, क्योंकि इससे साफ़ तौर पर पता चलता है कि पैकेज का नाम बिलकुल सटीक है और फ़ाइल फ़ोल्डर की टॉप-लेवल डायरेक्ट्री में रूट किया गया है.

रिलेटिव लेबल का इस्तेमाल, दूसरे पैकेज में मौजूद टारगेट का रेफ़रंस देने के लिए नहीं किया जा सकता. इस मामले में, हमेशा रिपॉज़िटरी आइडेंटिफ़ायर और पैकेज का नाम बताना ज़रूरी है. उदाहरण के लिए, अगर सोर्स ट्री में पैकेज my/app और पैकेज my/app/testdata, दोनों मौजूद हैं (इन दोनों डायरेक्ट्री में अपनी BUILD फ़ाइल है), तो दूसरे पैकेज में testdepot.zip नाम की फ़ाइल मौजूद है. //my/app:BUILD में इस फ़ाइल को रेफ़र करने के दो तरीके (एक गलत, एक सही) यहां दिए गए हैं:

गलतtestdata एक अलग पैकेज है, इसलिए रिलेटिव पाथ का इस्तेमाल नहीं किया जा सकता

testdata/testdepot.zip

सहीtestdata को उसके पूरे पाथ के साथ देखें

//my/app/testdata:testdepot.zip

@// से शुरू होने वाले लेबल, डेटा स्टोर करने की मुख्य जगह के रेफ़रंस होते हैं. ये लेबल, डेटा स्टोर करने की बाहरी जगहों से भी काम करेंगे. इसलिए, किसी बाहरी रिपॉज़िटरी से रेफ़रंस लेने पर, @//a/b/c, //a/b/c से अलग होता है. पहला, मुख्य रिपॉज़िटरी पर वापस ले जाता है, जबकि दूसरा, बाहरी रिपॉज़िटरी में //a/b/c खोजता है. यह खास तौर पर तब ज़रूरी होता है, जब मुख्य रिपॉज़िटरी में ऐसे नियम लिखे जा रहे हों जो मुख्य रिपॉज़िटरी में मौजूद टारगेट का रेफ़रंस देते हों और जिनका इस्तेमाल बाहरी रिपॉज़िटरी से किया जाएगा.

टारगेट को रेफ़र करने के अलग-अलग तरीकों के बारे में जानने के लिए, टारगेट पैटर्न देखें.

लेबल के बारे में लेक्सिकल जानकारी

लेबल सिंटैक्स ऐसे मेटावर्णों के इस्तेमाल को रोकने की कोशिश करता है जिनका शेल के लिए खास मतलब होता है. इससे, अनजाने में कोटेशन में शामिल होने से जुड़ी समस्याओं से बचा जा सकता है. साथ ही, Bazel क्वेरी लैंग्वेज जैसे लेबल में बदलाव करने वाले टूल और स्क्रिप्ट को आसानी से बनाया जा सकता है.

टारगेट के लिए, सही नामों की जानकारी नीचे दी गई है.

टारगेट के नाम — package-name:target-name

target-name, पैकेज में मौजूद टारगेट का नाम होता है. BUILD फ़ाइल में, नियम का नाम उस नियम की घोषणा में मौजूद, name एट्रिब्यूट की वैल्यू होता है. फ़ाइल का नाम BUILD फ़ाइल वाली डायरेक्ट्री के नाम से मिलता-जुलता पाथ होता है.

टारगेट के नाम, az, AZ, 09 सेट में मौजूद वर्णों और विराम चिह्नों !%-@^_"#$&'()*-+,;<=>?[]{|}~/. से ही बनाए जाने चाहिए.

फ़ाइल के नाम, सामान्य फ़ॉर्मैट में रिलेटिव पाथनेम होने चाहिए. इसका मतलब है कि इनकी शुरुआत और आखिर में स्लैश नहीं होना चाहिए. उदाहरण के लिए, /foo और foo/ का इस्तेमाल नहीं किया जा सकता. साथ ही, पाथ को अलग करने के लिए, एक के बाद एक कई स्लैश का इस्तेमाल नहीं किया जा सकता. उदाहरण के लिए, foo//bar. इसी तरह, अप-लेवल रेफ़रंस (..) और मौजूदा डायरेक्ट्री रेफ़रंस (./) का इस्तेमाल भी नहीं किया जा सकता.

गलत — अन्य पैकेज की फ़ाइलों का रेफ़रंस देने के लिए, `..` का इस्तेमाल न करें

सही — इस्तेमाल करें `//package-name:filename`

हालांकि, फ़ाइल टारगेट के नाम में / का इस्तेमाल करना आम बात है, लेकिन नियमों के नाम में / का इस्तेमाल करने से बचें. खास तौर पर, जब किसी लेबल का शॉर्टहैंड फ़ॉर्म इस्तेमाल किया जाता है, तो इससे पाठक उलझन में पड़ सकते हैं. //foo/bar/wiz लेबल, //foo/bar/wiz:wiz के लिए हमेशा एक शॉर्टहैंड होता है, भले ही ऐसा कोई पैकेज foo/bar/wiz न हो. यह //foo:bar/wiz का कभी भी ज़िक्र नहीं करता, भले ही टारगेट मौजूद हो.

हालांकि, कुछ मामलों में स्लैश का इस्तेमाल करना आसान होता है या कभी-कभी ज़रूरी भी होता है. उदाहरण के लिए, कुछ नियमों का नाम उनकी मुख्य सोर्स फ़ाइल से मेल खाना चाहिए, जो पैकेज की सबडायरेक्ट्री में मौजूद हो सकता है.

पैकेज के नाम — //package-name:target-name

पैकेज का नाम उस डायरेक्ट्री का नाम होता है जिसमें उसकी BUILD फ़ाइल होती है. यह नाम, डेटा स्टोर करने की जगह की टॉप-लेवल डायरेक्ट्री के नाम होता है. उदाहरण के लिए: my/app.

पैकेज के नाम A-Z, az, 09, '/', '-', '.', '@', और '_' सेट से लिए गए वर्णों से बने होने चाहिए और स्लैश से शुरू नहीं हो सकते.

किसी ऐसी भाषा के लिए जिसका डायरेक्ट्री स्ट्रक्चर, उसके मॉड्यूल सिस्टम (जैसे, Java) के लिए अहम है, यह ज़रूरी है कि डायरेक्ट्री के ऐसे नाम चुने जाएं जो भाषा में मान्य आइडेंटिफ़ायर हों.

Bazel, वर्कस्पेस के रूट पैकेज (उदाहरण के लिए, //:foo) में टारगेट के साथ काम करता है. हालांकि, उस पैकेज को खाली छोड़ना सबसे अच्छा होता है, ताकि सभी काम के पैकेज के नाम जानकारी देने वाले हों.

पैकेज के नाम में सबस्ट्रिंग // नहीं होनी चाहिए. साथ ही, इनके आखिर में स्लैश नहीं होना चाहिए.

नियम

नियम, इनपुट और आउटपुट के बीच के संबंध की जानकारी देता है. साथ ही, आउटपुट बनाने के चरणों की जानकारी भी देता है. नियम कई तरह के हो सकते हैं. इन्हें कभी-कभी नियम क्लास भी कहा जाता है. ये बिल्ड एनसाइक्लोपीडिया में बताए गए तरीके से, इकट्ठा किए गए रन किए जा सकने वाले प्रोग्राम और लाइब्रेरी, रन किए जा सकने वाले प्रोग्राम की जांच, और काम करने वाले अन्य आउटपुट बनाते हैं.

BUILD फ़ाइलें, नियम लागू करके टारगेट तय करती हैं.

नीचे दिए गए उदाहरण में, हमने cc_binary नियम का इस्तेमाल करके, टारगेट my_app का एलान किया है.

cc_binary(
    name = "my_app",
    srcs = ["my_app.cc"],
    deps = [
        "//absl/base",
        "//absl/strings",
    ],
)

हर नियम के लागू होने पर, name एट्रिब्यूट का इस्तेमाल किया जाता है. यह एट्रिब्यूट, BUILD फ़ाइल के पैकेज में मौजूद टारगेट की जानकारी देता है. यह एट्रिब्यूट, टारगेट का मान्य नाम होना चाहिए.

हर नियम में एट्रिब्यूट का एक सेट होता है. किसी दिए गए नियम के लिए लागू होने वाले एट्रिब्यूट और हर एट्रिब्यूट का मतलब और सेमेटिक्स, नियम के टाइप पर निर्भर करता है. नियमों और उनके एट्रिब्यूट की सूची के लिए, बिल्ड एनसाइक्लोपीडिया देखें. हर एट्रिब्यूट का एक नाम और टाइप होता है. किसी एट्रिब्यूट के कुछ सामान्य टाइप ये हो सकते हैं: पूर्णांक, लेबल, लेबल की सूची, स्ट्रिंग, स्ट्रिंग की सूची, आउटपुट लेबल, आउटपुट लेबल की सूची. हर नियम में सभी एट्रिब्यूट के बारे में बताना ज़रूरी नहीं है. इस तरह, एट्रिब्यूट एक डिक्शनरी बनाते हैं, जिसमें कुंजियों (नामों) से लेकर वैकल्पिक, टाइप की गई वैल्यू तक शामिल होती हैं.

कई नियमों में मौजूद srcs एट्रिब्यूट का टाइप "लेबल की सूची" होता है. अगर इसकी वैल्यू मौजूद है, तो यह लेबल की सूची होती है. हर लेबल, इस नियम के इनपुट के तौर पर काम करने वाले टारगेट का नाम होता है.

कुछ मामलों में, नियम के टाइप का नाम कुछ हद तक मनमुताबिक होता है. साथ ही, नियम से जनरेट की गई फ़ाइलों के नाम ज़्यादा दिलचस्प होते हैं. यह बात genrules के लिए भी सही है. ज़्यादा जानकारी के लिए, सामान्य नियम: genन्या देखें.

अन्य मामलों में, यह नाम अहम होता है: *_binary और *_test नियमों के लिए, उदाहरण के लिए, नियम का नाम बिल्ड के ज़रिए बने एक्ज़ीक्यूटेबल का नाम तय करता है.

टारगेट पर आधारित इस डायरेक्टेड ऐसाइक्लिक ग्राफ़ को टारगेट ग्राफ़ या बिल्ड डिपेंडेंसी ग्राफ़ कहा जाता है. यह वह डोमेन है जिस पर Bazel क्वेरी टूल काम करता है.

टारगेट BUILD फ़ाइलें