aboutsummaryrefslogtreecommitdiff
path: root/docs/run_binary_doc.md
diff options
context:
space:
mode:
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2021-08-06 03:02:07 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2021-08-06 03:02:07 +0000
commit74e2f30060dae33d5ca9f81e1d1614d06b4c1d06 (patch)
treec0a2a33d1d43e687f4fe1134ac14c09a9af5b8c0 /docs/run_binary_doc.md
parent971a80aefc3abdad1f8dcd6ff84eb6fb81147a45 (diff)
parente3e4f5325f3a9b46381531439b27dcfb294477fe (diff)
downloadbazel-skylib-android13-release.tar.gz
Snap for 7615884 from e3e4f5325f3a9b46381531439b27dcfb294477fe to tm-releaseandroid-vts-13.0_r8android-vts-13.0_r7android-vts-13.0_r6android-vts-13.0_r5android-vts-13.0_r4android-vts-13.0_r3android-vts-13.0_r2android-vts-13.0_r1android-security-13.0.0_r9android-security-13.0.0_r8android-security-13.0.0_r7android-security-13.0.0_r6android-security-13.0.0_r5android-security-13.0.0_r4android-security-13.0.0_r3android-security-13.0.0_r2android-security-13.0.0_r18android-security-13.0.0_r17android-security-13.0.0_r16android-security-13.0.0_r15android-security-13.0.0_r14android-security-13.0.0_r13android-security-13.0.0_r12android-security-13.0.0_r11android-security-13.0.0_r10android-security-13.0.0_r1android-platform-13.0.0_r9android-platform-13.0.0_r8android-platform-13.0.0_r7android-platform-13.0.0_r6android-platform-13.0.0_r5android-platform-13.0.0_r4android-platform-13.0.0_r3android-platform-13.0.0_r20android-platform-13.0.0_r2android-platform-13.0.0_r19android-platform-13.0.0_r18android-platform-13.0.0_r17android-platform-13.0.0_r16android-platform-13.0.0_r15android-platform-13.0.0_r14android-platform-13.0.0_r13android-platform-13.0.0_r12android-platform-13.0.0_r11android-platform-13.0.0_r10android-platform-13.0.0_r1android-cts-13.0_r8android-cts-13.0_r7android-cts-13.0_r6android-cts-13.0_r5android-cts-13.0_r4android-cts-13.0_r3android-cts-13.0_r2android-cts-13.0_r1android-13.0.0_r8android-13.0.0_r7android-13.0.0_r6android-13.0.0_r5android-13.0.0_r4android-13.0.0_r31android-13.0.0_r3android-13.0.0_r2android-13.0.0_r12android-13.0.0_r1android13-tests-releaseandroid13-security-releaseandroid13-s3-releaseandroid13-s2-releaseandroid13-s1-releaseandroid13-releaseandroid13-platform-releaseandroid13-gsi
Change-Id: Ib00b49264b55c948afe369739aac5cb111d9ef96
Diffstat (limited to 'docs/run_binary_doc.md')
-rwxr-xr-xdocs/run_binary_doc.md75
1 files changed, 75 insertions, 0 deletions
diff --git a/docs/run_binary_doc.md b/docs/run_binary_doc.md
new file mode 100755
index 0000000..188e277
--- /dev/null
+++ b/docs/run_binary_doc.md
@@ -0,0 +1,75 @@
+<a name="#run_binary"></a>
+## run_binary
+
+<pre>
+run_binary(<a href="#run_binary-name">name</a>, <a href="#run_binary-args">args</a>, <a href="#run_binary-env">env</a>, <a href="#run_binary-outs">outs</a>, <a href="#run_binary-srcs">srcs</a>, <a href="#run_binary-tool">tool</a>)
+</pre>
+
+Runs a binary as a build action.<br/><br/>This rule does not require Bash (unlike <code>native.genrule</code>).
+
+### Attributes
+
+<table class="params-table">
+ <colgroup>
+ <col class="col-param" />
+ <col class="col-description" />
+ </colgroup>
+ <tbody>
+ <tr id="run_binary-name">
+ <td><code>name</code></td>
+ <td>
+ <a href="https://bazel.build/docs/build-ref.html#name">Name</a>; required
+ <p>
+ A unique name for this target.
+ </p>
+ </td>
+ </tr>
+ <tr id="run_binary-args">
+ <td><code>args</code></td>
+ <td>
+ List of strings; optional
+ <p>
+ Command line arguments of the binary.<br/><br/>Subject to<code><a href="https://docs.bazel.build/versions/master/be/make-variables.html#location">$(location)</a></code> expansion.
+ </p>
+ </td>
+ </tr>
+ <tr id="run_binary-env">
+ <td><code>env</code></td>
+ <td>
+ <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a>; optional
+ <p>
+ Environment variables of the action.<br/><br/>Subject to <code><a href="https://docs.bazel.build/versions/master/be/make-variables.html#location">$(location)</a></code> expansion.
+ </p>
+ </td>
+ </tr>
+ <tr id="run_binary-outs">
+ <td><code>outs</code></td>
+ <td>
+ List of labels; required
+ <p>
+ Output files generated by the action.<br/><br/>These labels are available for <code>$(location)</code> expansion in <code>args</code> and <code>env</code>.
+ </p>
+ </td>
+ </tr>
+ <tr id="run_binary-srcs">
+ <td><code>srcs</code></td>
+ <td>
+ <a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a>; optional
+ <p>
+ Additional inputs of the action.<br/><br/>These labels are available for <code>$(location)</code> expansion in <code>args</code> and <code>env</code>.
+ </p>
+ </td>
+ </tr>
+ <tr id="run_binary-tool">
+ <td><code>tool</code></td>
+ <td>
+ <a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; required
+ <p>
+ The tool to run in the action.<br/><br/>Must be the label of a *_binary rule, of a rule that generates an executable file, or of a file that can be executed as a subprocess (e.g. an .exe or .bat file on Windows or a binary with executable permission on Linux). This label is available for <code>$(location)</code> expansion in <code>args</code> and <code>env</code>.
+ </p>
+ </td>
+ </tr>
+ </tbody>
+</table>
+
+