Aturan Tindakan Tambahan

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

Aturan

action_listener

Lihat sumber aturan
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)

PERINGATAN: Tindakan tambahan tidak digunakan lagi. Sebagai gantinya, gunakan aspek.

Aturan action_listener tidak menghasilkan output apa pun. Sebagai gantinya, ini memungkinkan developer alat menyisipkan extra_action ke dalam sistem build, dengan menyediakan pemetaan dari tindakan ke extra_action .

Argumen aturan ini memetakan mnemoni tindakan ke aturan extra_action.

Dengan menentukan opsi --experimental_action_listener=<label>, build akan menggunakan action_listener yang ditentukan untuk menyisipkan extra_action ke dalam grafik build.

Contoh

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)",
)

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

extra_actions

Daftar label; wajib diisi

Daftar target extra_action yang harus ditambahkan action_listener ini ke grafik build. Misalnya, [ "//my/tools:analyzer" ].
mnemonics

Daftar string; wajib diisi

Daftar mnemoni tindakan yang harus diproses oleh action_listener ini, misalnya [ "Javac" ].

Mnemonik bukan antarmuka publik. Tidak ada jaminan bahwa mnemoni dan tindakannya tidak berubah.

extra_action

Lihat sumber aturan
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)

PERINGATAN: Tindakan tambahan tidak digunakan lagi. Sebagai gantinya, gunakan aspek.

Aturan extra_action tidak menghasilkan output yang bermakna saat ditentukan sebagai target build reguler. Sebagai gantinya, API ini memungkinkan developer alat menyisipkan tindakan tambahan ke dalam grafik build yang mengikuti tindakan yang ada.

Lihat action_listener untuk mengetahui detail cara mengaktifkan extra_action.

extra_action berjalan sebagai command line. Alat command line mendapatkan akses ke file yang berisi buffering protokol sebagai $(EXTRA_ACTION_FILE) dengan informasi mendetail tentang tindakan asli yang dibayanginya. Tindakan ini juga memiliki akses ke semua file input yang dapat diakses oleh tindakan asli. Lihat extra_actions_base.proto untuk mengetahui detail tentang data yang disimpan di dalam buffering protokol. Setiap file proto berisi pesan ExtraActionInfo.

Sama seperti semua tindakan lainnya, tindakan tambahan di-sandbox, dan harus dirancang untuk menanganinya.

Argumen

Atribut
name

Nama; wajib

Nama unik untuk target ini.

Anda dapat merujuk ke aturan ini dengan label dalam argumen extra_actions dari aturan action_listener.
cmd

String; wajib

Perintah yang akan dijalankan.

Seperti atribut cmd genrule dengan perbedaan berikut:

  1. Tidak ada perluasan label heuristik. Hanya label yang menggunakan $(location ...) yang diperluas.

  2. Kartu tambahan diterapkan ke string untuk mengganti semua kemunculan output yang dibuat dari atribut out_templates. Semua kemunculan $(output out_template) diganti dengan jalur ke file yang ditunjukkan oleh label.

    Misalnya, out_template $(ACTION_ID).analysis dapat dicocokkan dengan $(output $(ACTION_ID).analysis).

    Akibatnya, ini adalah penggantian yang sama dengan $(location), tetapi dengan cakupan yang berbeda.

out_templates

Daftar string; default-nya adalah []

Daftar template untuk file yang dihasilkan oleh perintah extra_action.

Template ini dapat menggunakan variabel berikut:

  • $(ACTION_ID), ID yang secara unik mengidentifikasi extra_action ini. Digunakan untuk membuat file output unik.

requires_action_output

Boolean; default-nya adalah False

Menunjukkan bahwa extra_action ini memerlukan output tindakan asli untuk ditampilkan sebagai input ke extra_action ini.

Jika benar (default salah), extra_action dapat mengasumsikan bahwa output tindakan asli tersedia sebagai bagian dari inputnya.

tools

Daftar label; default-nya adalah []

Daftar dependensi tool untuk aturan ini.

Lihat definisi dependensi untuk mengetahui informasi selengkapnya.

Sistem build memastikan prasyarat ini di-build sebelum menjalankan perintah extra_action; prasyarat ini di-build menggunakan konfigurasi exec, karena harus berjalan sebagai alat selama build itu sendiri. Jalur setiap //x:y target tools dapat diperoleh menggunakan $(location //x:y).

Semua alat dan dependensi datanya digabungkan ke dalam satu hierarki tempat perintah dapat menggunakan jalur relatif. Direktori kerja akan menjadi root dari hierarki terpadu tersebut.