diff options
Diffstat (limited to 'docs/write_file_doc.md')
| -rwxr-xr-x | docs/write_file_doc.md | 92 |
1 files changed, 24 insertions, 68 deletions
diff --git a/docs/write_file_doc.md b/docs/write_file_doc.md index d8f098e..8f39376 100755 --- a/docs/write_file_doc.md +++ b/docs/write_file_doc.md @@ -1,3 +1,17 @@ +<!-- Generated with Stardoc: http://skydoc.bazel.build --> + +A rule that writes a UTF-8 encoded text file from user-specified contents. + +native.genrule() is sometimes used to create a text file. The 'write_file' and +macro does this with a simpler interface than genrule. + +The rules generated by the macro do not use Bash or any other shell to write the +file. Instead they use Starlark's built-in file writing action +(ctx.actions.write). + + +<a id="#write_file"></a> + ## write_file <pre> @@ -6,74 +20,16 @@ write_file(<a href="#write_file-name">name</a>, <a href="#write_file-out">out</a Creates a UTF-8 encoded text file. -### Parameters +**PARAMETERS** + -<table class="params-table"> - <colgroup> - <col class="col-param" /> - <col class="col-description" /> - </colgroup> - <tbody> - <tr id="write_file-name"> - <td><code>name</code></td> - <td> - required. - <p> - Name of the rule. - </p> - </td> - </tr> - <tr id="write_file-out"> - <td><code>out</code></td> - <td> - required. - <p> - Path of the output file, relative to this package. - </p> - </td> - </tr> - <tr id="write_file-content"> - <td><code>content</code></td> - <td> - optional. default is <code>[]</code> - <p> - A list of strings. Lines of text, the contents of the file. - Newlines are added automatically after every line except the last one. - </p> - </td> - </tr> - <tr id="write_file-is_executable"> - <td><code>is_executable</code></td> - <td> - optional. default is <code>False</code> - <p> - A boolean. Whether to make the output file executable. - When True, the rule's output can be executed using `bazel run` and can - be in the srcs of binary and test rules that require executable - sources. - </p> - </td> - </tr> - <tr id="write_file-newline"> - <td><code>newline</code></td> - <td> - optional. default is <code>"auto"</code> - <p> - one of ["auto", "unix", "windows"]: line endings to use. "auto" - for platform-determined, "unix" for LF, and "windows" for CRLF. - </p> - </td> - </tr> - <tr id="write_file-kwargs"> - <td><code>kwargs</code></td> - <td> - optional. - <p> - further keyword arguments, e.g. <code>visibility</code> - </p> - </td> - </tr> - </tbody> -</table> +| Name | Description | Default Value | +| :------------- | :------------- | :------------- | +| <a id="write_file-name"></a>name | Name of the rule. | none | +| <a id="write_file-out"></a>out | Path of the output file, relative to this package. | none | +| <a id="write_file-content"></a>content | A list of strings. Lines of text, the contents of the file. Newlines are added automatically after every line except the last one. | <code>[]</code> | +| <a id="write_file-is_executable"></a>is_executable | A boolean. Whether to make the output file executable. When True, the rule's output can be executed using <code>bazel run</code> and can be in the srcs of binary and test rules that require executable sources. | <code>False</code> | +| <a id="write_file-newline"></a>newline | one of ["auto", "unix", "windows"]: line endings to use. "auto" for platform-determined, "unix" for LF, and "windows" for CRLF. | <code>"auto"</code> | +| <a id="write_file-kwargs"></a>kwargs | further keyword arguments, e.g. <code>visibility</code> | none | |