अतिरिक्त कार्रवाइयों के नियम

नियम

action_listener

नियम का सोर्स देखें
action_listener(name, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, extra_actions, features, licenses, mnemonics, restricted_to, tags, target_compatible_with, testonly, visibility)

चेतावनी: अतिरिक्त कार्रवाइयों का इस्तेमाल बंद कर दिया गया है. इसके बजाय, aspects का इस्तेमाल करें.

action_listener नियम खुद कोई आउटपुट नहीं देता. इसके बजाय, यह टूल डेवलपर को बिल्ड सिस्टम में extra_action डालने की अनुमति देता है. इसके लिए, ऐक्शन से extra_action की मैपिंग की जाती है.

इस नियम के आर्ग्युमेंट, ऐक्शन के लिए याद रखने लायक शब्दों को extra_action नियमों पर मैप करते हैं.

--experimental_action_listener=<label> विकल्प चुनने पर, बिल्ड ग्राफ़ में extra_action डालने के लिए, बिल्ड में बताए गए action_listener का इस्तेमाल किया जाएगा.

उदाहरण

action_listener(
    name = "index_all_languages",
    mnemonics = [
        "Javac",
        "CppCompile",
        "Python",
    ],
    extra_actions = [":indexer"],
)

action_listener(
    name = "index_java",
    mnemonics = ["Javac"],
    extra_actions = [":indexer"],
)

extra_action(
    name = "indexer",
    tools = ["//my/tools:indexer"],
    cmd = "$(location //my/tools:indexer)" +
          "--extra_action_file=$(EXTRA_ACTION_FILE)",
)

तर्क

विशेषताएं
name

नाम; ज़रूरी है

इस टारगेट के लिए यूनीक नाम.

extra_actions

लेबल की सूची; ज़रूरी है

extra_action टारगेट की सूची इस action_listener को बिल्ड ग्राफ़ में जोड़ना चाहिए. उदाहरण के लिए, [ "//my/tools:analyzer" ].
mnemonics

स्ट्रिंग की सूची; ज़रूरी है

ऐक्शन के उन मेनेमोनिक की सूची जिन पर इस action_listener को ध्यान देना चाहिए, जैसे कि [ "Javac" ].

मेमोनेमिक, सार्वजनिक इंटरफ़ेस नहीं होते. इस बात की कोई गारंटी नहीं है कि याद रखने की कला और उनके काम में कोई बदलाव नहीं होगा.

extra_action

नियम का सोर्स देखें
extra_action(name, data, cmd, compatible_with, deprecation, distribs, exec_compatible_with, exec_properties, features, licenses, out_templates, requires_action_output, restricted_to, tags, target_compatible_with, testonly, toolchains, tools, visibility)

चेतावनी: अतिरिक्त कार्रवाइयों के इस्तेमाल पर रोक लगा दी गई है. इसके बजाय, आसपेक्ट का इस्तेमाल करें.

सामान्य बिल्ड टारगेट के तौर पर बताए जाने पर, extra_action नियम काम का कोई आउटपुट नहीं देता है. इसके बजाय, यह टूल डेवलपर को बिल्ड ग्राफ़ में ऐसी अतिरिक्त कार्रवाइयां डालने की अनुमति देता है जो मौजूदा कार्रवाइयों को शैडो करती हैं.

extra_action को चालू करने के तरीके के बारे में जानकारी पाने के लिए, action_listener देखें.

extra_action, कमांड-लाइन के तौर पर काम करते हैं. कमांड-लाइन टूल को, $(EXTRA_ACTION_FILE) के तौर पर प्रोटोकॉल बफ़र वाली फ़ाइल का ऐक्सेस मिलता है. इसमें, ओरिजनल ऐक्शन के बारे में पूरी जानकारी होती है. इसके पास उन सभी इनपुट फ़ाइलों का ऐक्सेस भी होता है जिनका ऐक्सेस ओरिजनल ऐक्शन के पास है. प्रोटोकॉल बफ़र में सेव किए गए डेटा के बारे में जानकारी पाने के लिए, extra_actions_base.proto देखें. हर प्रोटो फ़ाइल में एक ExtraActionInfo मैसेज होता है.

दूसरी सभी कार्रवाइयों की तरह ही, अतिरिक्त कार्रवाइयां सैंडबॉक्स की जाती हैं और उन्हें इस हिसाब से डिज़ाइन किया जाना चाहिए.

तर्क

विशेषताएं
name

नाम; ज़रूरी है

इस टारगेट के लिए यूनीक नाम.

इस नियम का रेफ़रंस देने के लिए, action_listener नियमों के extra_actions आर्ग्युमेंट में label का इस्तेमाल करें.
cmd

स्ट्रिंग; ज़रूरी है

चलाने के लिए निर्देश.

यह genrule cmd एट्रिब्यूट की तरह ही है. हालांकि, इनमें ये अंतर हैं:

  1. अनुमान के हिसाब से लेबल को बढ़ाया नहीं जा सकता. सिर्फ़ $(location ...) का इस्तेमाल करने वाले लेबल को बड़ा किया जाता है.

  2. स्ट्रिंग पर एक अतिरिक्त पास लागू किया जाता है, ताकि out_templates एट्रिब्यूट से बनाए गए सभी आउटपुट को बदला जा सके. $(output out_template) के सभी इंस्टेंस, label से दिखाए गए फ़ाइल के पाथ से बदल दिए जाते हैं.

    उदाहरण के लिए, out_template $(ACTION_ID).analysis का मिलान $(output $(ACTION_ID).analysis) से किया जा सकता है.

    असल में, यह $(location) जैसा ही सबस्टिट्यूशन है, लेकिन इसका दायरा अलग है.

out_templates

स्ट्रिंग की सूची; डिफ़ॉल्ट [] है

extra_action निर्देश से जनरेट की गई फ़ाइलों के लिए टेंप्लेट की सूची.

टेंप्लेट में इन वैरिएबल का इस्तेमाल किया जा सकता है:

  • $(ACTION_ID), एक आईडी है जो इस extra_action की खास तौर पर पहचान करता है. इसका इस्तेमाल, यूनीक आउटपुट फ़ाइल जनरेट करने के लिए किया जाता है.

requires_action_output

बूलियन; डिफ़ॉल्ट False है

इससे पता चलता है कि extra_action को इस extra_action के इनपुट के तौर पर ओरिजनल कार्रवाई के आउटपुट का होना ज़रूरी है.

अगर यह 'सही है' (डिफ़ॉल्ट रूप से 'गलत है') पर सेट है, तो extra_action यह मान सकता है कि ओरिजनल ऐक्शन के आउटपुट, इनपुट के तौर पर उपलब्ध हैं.

tools

लेबल की सूची; डिफ़ॉल्ट [] है

इस नियम के लिए tool डिपेंडेंसी की सूची.

ज़्यादा जानकारी के लिए, डिपेंडेंसी की परिभाषा देखें.

बिल्ड सिस्टम यह पक्का करता है कि extra_action कमांड को चलाने से पहले, ये ज़रूरी शर्तें पूरी हो गई हों. इन्हें execकॉन्फ़िगरेशन का इस्तेमाल करके बनाया जाता है, क्योंकि इन्हें बिल्ड के दौरान टूल के तौर पर चलाना ज़रूरी होता है. किसी व्यक्तिगत tools टारगेट //x:y का पाथ, $(location //x:y) का इस्तेमाल करके हासिल किया जा सकता है.

सभी टूल और उनकी डेटा डिपेंडेंसी एक ही ट्री में एक साथ रखी जाती हैं. इसमें कमांड, मिलते-जुलते पाथ का इस्तेमाल कर सकती है. काम करने वाली डायरेक्ट्री, उस यूनिफ़ाइड ट्री का रूट होगी.