Spec-Zone.ru › Bazel 6.1

Правила дополнительных действий

Правила

  • action_listener
  • extra_action

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)

ПРЕДУПРЕЖДЕНИЕ: Дополнительные действия устарели. Используйте модули вместо этого.

Правило 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

Список extra_action целей, которые это action_listener должно добавить в граф сборки. Например, [ "//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)

ПРЕДУПРЕЖДЕНИЕ: Дополнительные действия устарели. Используйте модули вместо этого.

Правило extra_action не генерирует значимого вывода, когда указано как обычная цель сборки. Вместо этого оно позволяет разработчикам инструментов вставлять дополнительные действия в граф сборки, которые маскируют существующие действия.

См. action_listener для получения подробностей о том, как включить extra_action.

extra_action выполняются как команда в командной строке. Инструмент командной строки получает доступ к файлу, содержащему протокол буфер, как $(EXTRA_ACTION_FILE) с подробной информацией о затеняемом исходном действии. Он также получает доступ ко всем входным файлам, к которым имеет доступ исходное действие. См. extra_actions_base.proto для получения подробностей о данных, хранящихся в протоколе буфера. Каждый файл протокола содержит сообщение ExtraActionInfo.

Как и все другие действия, дополнительные действия защищены от сбоев и должны быть спроектированы с учетом этого.

Аргументы

Атрибуты
name

Name; required

Уникальное имя для этой цели.

Вы можете ссылаться на это правило по label в аргументе extra_actions правил action_listener.
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), идентификатор, уникально определяющий это 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 выполнения; они собираются с использованием hostконфигурации, поскольку они должны выполняться как инструмент во время самой сборки. Путь к отдельной tools цели //x:y может быть получен с использованием $(location //x:y).

Все инструменты и их зависимости данных консолидируются в одном дереве, в пределах которого команда может использовать относительные пути. Рабочий каталог будет корнем этого объединенного дерева.

За исключением случаев, оговоренных в ином порядке, содержимое этой страницы лицензируется по лицензии Creative Commons Attribution 4.0, а примеры кода лицензируются по лицензии Apache 2.0. Подробности см. в Политике сайта Google для разработчиков. Java является зарегистрированным товарным знаком Oracle и/или ее дочерних компаний.

Последнее обновление 2023-03-15 по UTC.

Licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.
https://bazel.build/versions/6.1.0/reference/be/extra-actions

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API