額外動作規則

回報問題 查看原始碼

規則

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> 選項之後,建構作業會使用指定的 action_listener,將 extra_action 插入建構圖形中。

範例

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

Name; required

此目標的專屬名稱。

extra_actions

List of labels; required

action_listener 應新增至建構圖表的 extra_action 目標清單。例如:[ "//my/tools:analyzer" ]
mnemonics

List of strings; required

這個 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)

警告:這個額外動作已遭淘汰。請改用 aspects

指定為一般建構目標時,extra_action 規則不會產生任何有意義的輸出內容。但允許工具開發人員在建構圖表中插入會覆蓋現有動作的其他動作。

如要進一步瞭解如何啟用 extra_action,請參閱 action_listener

extra_action 會以指令列的形式執行。指令列工具可讓您取得含有 $(EXTRA_ACTION_FILE) 通訊協定緩衝區的檔案,以及其所覆蓋原始動作的詳細資訊。 還能存取原始動作可存取的所有輸入檔案。如要進一步瞭解通訊協定緩衝區中儲存的資料,請參閱 extra_actions_base.proto。每個 proto 檔案都包含 ExtraActionInfo 訊息。

和其他動作一樣,其他動作均採用沙箱機制,設計時應加以處理。

引數

屬性
name

Name; required

此目標的專屬名稱。

action_listener 規則的 extra_actions 引數中,您可以透過 label 參照這項規則。
cmd

String; required

要執行的指令。

genrule cmd 屬性一樣,如有下列差異:

  1. 無法擴充經驗法則。只有使用 $(location ...) 的標籤才會展開。

  2. 系統會為字串套用額外的票證,以取代透過 out_templates 屬性建立的所有輸出內容。所有出現的 $(output out_template) 都會替換為由 label 表示的檔案路徑。

    例如:out_template $(ACTION_ID).analysis 可以與 $(output $(ACTION_ID).analysis) 進行比對。

    實際上,這與 $(location) 的替代項目相同,但範圍不同。

out_templates

List of strings; optional

extra_action 指令產生的檔案範本清單。

範本可以使用下列變數:

  • $(ACTION_ID) 這個 ID 可用於識別這個 extra_action。用來產生不重複的輸出檔案。

requires_action_output

Boolean; optional; default is False

表示此 extra_action 要求原始動作的輸出,做為此 extra_action 的輸入內容。

設為 true 時 (預設值為 false), extra_action 可假設原始動作輸出可作為輸入內容的一部分提供。

tools

List of labels; optional

這項規則的 tool 依附元件清單。

詳情請參閱依附元件的定義。

建構系統會在執行 extra_action 指令前建構這些必備條件;這些建構是使用 execconfiguration 進行建構,因為必須在建構期間以工具的形式執行。可使用 $(location //x:y) 取得個別 tools 目標 //x:y 的路徑。

所有工具及其資料依附元件都會合併為單一樹狀結構,其中指令可使用相對路徑。工作目錄將是該統一樹狀結構的根層級。