summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYifan Hong <elsk@google.com>2024-03-19 13:52:33 -0700
committerTreehugger Robot <android-test-infra-autosubmit@system.gserviceaccount.com>2024-03-19 23:20:28 +0000
commite387fc84d20f5c86867c647c227d8b872da7d8bf (patch)
tree819092d4c4143bfbddc089b4dec1c45f4f4359c6
parent7bceb21ce4aa772d733a6172bde0bf9b7bc197d4 (diff)
downloadbuild-e387fc84d20f5c86867c647c227d8b872da7d8bf.tar.gz
kleaf: Update docs for kernel_modules_install.outs.
Test: N/A Bug: 327533166 Change-Id: I326ed34b085f993bf0d4bcfc84f41c851cd51326
-rw-r--r--kleaf/docs/api_reference/kernel.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/kleaf/docs/api_reference/kernel.md b/kleaf/docs/api_reference/kernel.md
index 2b37f7e..a2410e7 100644
--- a/kleaf/docs/api_reference/kernel.md
+++ b/kleaf/docs/api_reference/kernel.md
@@ -384,7 +384,7 @@ kernel_modules_install(
## kernel_modules_install
<pre>
-kernel_modules_install(<a href="#kernel_modules_install-name">name</a>, <a href="#kernel_modules_install-kernel_build">kernel_build</a>, <a href="#kernel_modules_install-kernel_modules">kernel_modules</a>)
+kernel_modules_install(<a href="#kernel_modules_install-name">name</a>, <a href="#kernel_modules_install-outs">outs</a>, <a href="#kernel_modules_install-kernel_build">kernel_build</a>, <a href="#kernel_modules_install-kernel_modules">kernel_modules</a>)
</pre>
Generates a rule that runs depmod in the module installation directory.
@@ -423,6 +423,7 @@ In `foo_dist`, specifying `foo_modules_install` in `data` won't include
| Name | Description | Type | Mandatory | Default |
| :------------- | :------------- | :------------- | :------------- | :------------- |
| <a id="kernel_modules_install-name"></a>name | A unique name for this target. | <a href="https://bazel.build/concepts/labels#target-names">Name</a> | required | |
+| <a id="kernel_modules_install-outs"></a>outs | A list of additional outputs from `make modules_install`.<br><br>Since external modules are returned by default, it can be used to obtain modules.* related files (results of depmod). Only files with allowed names can be added to outs. (`_OUT_ALLOWLIST`) <pre><code>_OUT_ALLOWLIST = ["modules.dep", "modules.alias", "modules.builtin", "modules.symbols", "modules.softdep"]</code></pre> Example: <pre><code>kernel_modules_install(&#10; name = "foo_modules_install",&#10; kernel_modules = [":foo_module_list"],&#10; outs = [&#10; "modules.dep",&#10; "modules.alias",&#10; ],&#10;)</code></pre> | List of strings | optional | `[]` |
| <a id="kernel_modules_install-kernel_build"></a>kernel_build | Label referring to the `kernel_build` module. Otherwise, it is inferred from `kernel_modules`. | <a href="https://bazel.build/concepts/labels">Label</a> | optional | `None` |
| <a id="kernel_modules_install-kernel_modules"></a>kernel_modules | A list of labels referring to `kernel_module`s to install. | <a href="https://bazel.build/concepts/labels">List of labels</a> | optional | `[]` |