diff options
| author | Yifan Hong <elsk@google.com> | 2024-03-04 17:11:00 -0800 |
|---|---|---|
| committer | Yifan Hong <elsk@google.com> | 2024-03-06 01:17:52 +0000 |
| commit | c407278e379f019c92525a1f849d96649d7de3f9 (patch) | |
| tree | bd429646f1b46a2069e78e08f58b2ac22685a837 | |
| parent | 85e8d4762cb46442c4ba145c022f9cb0c96b02ce (diff) | |
| download | build-c407278e379f019c92525a1f849d96649d7de3f9.tar.gz | |
kleaf: Update docs. (2/2)
Mention that hermetic_tools.aliases is deprecated.
Test: TH
Bug: N/A
Fixes: 6746ab1a241a ("kleaf: Prevent the use of :hermetic-tools/<alias>.")
Change-Id: Id0c91eb2530f50c6a1ab64c3d612a059e0db0de7
| -rw-r--r-- | kleaf/docs/api_reference/hermetic_tools.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/kleaf/docs/api_reference/hermetic_tools.md b/kleaf/docs/api_reference/hermetic_tools.md index cbe9b31..6075eaa 100644 --- a/kleaf/docs/api_reference/hermetic_tools.md +++ b/kleaf/docs/api_reference/hermetic_tools.md @@ -120,7 +120,7 @@ Provide tools for a hermetic build. | <a id="hermetic_tools-name"></a>name | Name of the target. | none | | <a id="hermetic_tools-deps"></a>deps | additional dependencies. These aren't added to the `PATH`. | `None` | | <a id="hermetic_tools-symlinks"></a>symlinks | A dictionary, where keys are labels to an executable, and values are names to the tool, separated with `:`. e.g.<br><br><pre><code>{"//label/to:toybox": "cp:realpath"}</code></pre> | `None` | -| <a id="hermetic_tools-aliases"></a>aliases | [nonconfigurable](https://bazel.build/reference/be/common-definitions#configurable-attributes).<br><br>List of aliases to create to refer to a single tool.<br><br>For example, if `aliases = ["cp"],` then `<name>/cp` refers to a `cp`.<br><br>**Note**: It is not recommended to rely on these targets. Consider using the full hermetic toolchain with [`hermetic_toolchain`](#hermetic_toolchainget) or [`hermetic_genrule`](#hermetic_genrule), etc. | `None` | +| <a id="hermetic_tools-aliases"></a>aliases | **Deprecated; do not use.**<br><br>[nonconfigurable](https://bazel.build/reference/be/common-definitions#configurable-attributes).<br><br>List of aliases to create to refer to a `fail_rule`.<br><br>For example, if `aliases = ["cp"],` then usage of `<name>/cp` will fail.<br><br>**Note**: It is not allowed to rely on these targets. Consider using the full hermetic toolchain with [`hermetic_toolchain`](#hermetic_toolchainget) or [`hermetic_genrule`](#hermetic_genrule), etc. | `None` | | <a id="hermetic_tools-kwargs"></a>kwargs | Additional attributes to the internal rule, e.g. [`visibility`](https://docs.bazel.build/versions/main/visibility.html). See complete list [here](https://docs.bazel.build/versions/main/be/common-definitions.html#common | none | |