diff options
Diffstat (limited to 'docs/run_binary_doc.md')
| -rwxr-xr-x | docs/run_binary_doc.md | 84 |
1 files changed, 20 insertions, 64 deletions
diff --git a/docs/run_binary_doc.md b/docs/run_binary_doc.md index 188e277..96bada5 100755 --- a/docs/run_binary_doc.md +++ b/docs/run_binary_doc.md @@ -1,4 +1,13 @@ -<a name="#run_binary"></a> +<!-- Generated with Stardoc: http://skydoc.bazel.build --> + + +run_binary() build rule implementation. + +Runs a binary as a build action. This rule does not require Bash (unlike native.genrule()). + + +<a id="#run_binary"></a> + ## run_binary <pre> @@ -7,69 +16,16 @@ run_binary(<a href="#run_binary-name">name</a>, <a href="#run_binary-args">args< Runs a binary as a build action.<br/><br/>This rule does not require Bash (unlike <code>native.genrule</code>). -### Attributes +**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> +| Name | Description | Type | Mandatory | Default | +| :------------- | :------------- | :------------- | :------------- | :------------- | +| <a id="run_binary-name"></a>name | A unique name for this target. | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required | | +| <a id="run_binary-args"></a>args | Command line arguments of the binary.<br/><br/>Subject to<code><a href="https://docs.bazel.build/versions/main/be/make-variables.html#location">$(location)</a></code> expansion. | List of strings | optional | [] | +| <a id="run_binary-env"></a>env | Environment variables of the action.<br/><br/>Subject to <code><a href="https://docs.bazel.build/versions/main/be/make-variables.html#location">$(location)</a></code> expansion. | <a href="https://bazel.build/docs/skylark/lib/dict.html">Dictionary: String -> String</a> | optional | {} | +| <a id="run_binary-outs"></a>outs | 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>. | List of labels | required | | +| <a id="run_binary-srcs"></a>srcs | Additional inputs of the action.<br/><br/>These labels are available for <code>$(location)</code> expansion in <code>args</code> and <code>env</code>. | <a href="https://bazel.build/docs/build-ref.html#labels">List of labels</a> | optional | [] | +| <a id="run_binary-tool"></a>tool | 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>. | <a href="https://bazel.build/docs/build-ref.html#labels">Label</a> | required | | |