额外操作规则

报告问题 查看源代码

规则

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

名称（必需）

此目标的唯一名称。
extra_actions

标签列表（必需）

此 action_listener 应添加到构建图的 extra_action 目标的列表。 例如 [ "//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。每个 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 的 ID。 用于生成唯一的输出文件。

requires_action_output

布尔值；默认值为 False

表示此 extra_action 需要原始操作的输出作为此 extra_action 的输入。

如果为 true（默认值为 false），extra_action 可以假定原始操作输出可作为其输入的一部分。
tools

标签列表；默认值为 []

此规则的 tool 依赖项列表。

如需了解详情，请参阅依赖项的定义。

构建系统可确保在运行 extra_action 命令之前构建这些前提条件；它们使用 exec 配置构建，因为它们在构建本身期间必须作为工具运行。您可以使用 $(location //x:y) 获取单个 tools 目标 //x:y 的路径。

所有工具及其数据依赖关系都整合到单个树中，在该树中，命令可以使用相对路径。此工作目录将是该统一树的根目录。