49 lines
2.9 KiB
Markdown
49 lines
2.9 KiB
Markdown
|
<!-- Generated with Stardoc: http://skydoc.bazel.build -->
|
||
|
|
|
||
|
|
A rule that copies a file to another place.
|
||
|
|
|
||
|
|
native.genrule() is sometimes used to copy files (often wishing to rename them).
|
||
|
|
The 'copy_file' rule does this with a simpler interface than genrule.
|
||
|
|
|
||
|
|
The rule uses a Bash command on Linux/macOS/non-Windows, and a cmd.exe command
|
||
|
|
on Windows (no Bash is required).
|
||
|
|
|
||
|
|
This fork of bazel-skylib's copy_file adds directory support.
|
||
|
|
|
||
|
|
|
||
|
|
<a id="#copy_file"></a>
|
||
|
|
|
||
|
|
## copy_file
|
||
|
|
|
||
|
|
<pre>
|
||
|
|
copy_file(<a href="#copy_file-name">name</a>, <a href="#copy_file-src">src</a>, <a href="#copy_file-out">out</a>, <a href="#copy_file-is_directory">is_directory</a>, <a href="#copy_file-is_executable">is_executable</a>, <a href="#copy_file-allow_symlink">allow_symlink</a>, <a href="#copy_file-kwargs">kwargs</a>)
|
||
|
|
</pre>
|
||
|
|
|
||
|
|
Copies a file or directory to another location.
|
||
|
|
|
||
|
|
`native.genrule()` is sometimes used to copy files (often wishing to rename them). The 'copy_file' rule does this with a simpler interface than genrule.
|
||
|
|
|
||
|
|
This rule uses a Bash command on Linux/macOS/non-Windows, and a cmd.exe command on Windows (no Bash is required).
|
||
|
|
|
||
|
|
If using this rule with source directories, it is recommended that you use the
|
||
|
|
`--host_jvm_args=-DBAZEL_TRACK_SOURCE_DIRECTORIES=1` startup option so that changes
|
||
|
|
to files within source directories are detected. See
|
||
|
|
https://github.com/bazelbuild/bazel/commit/c64421bc35214f0414e4f4226cc953e8c55fa0d2
|
||
|
|
for more context.
|
||
|
|
|
||
|
|
|
||
|
|
**PARAMETERS**
|
||
|
|
|
||
|
|
|
||
|
|
| Name | Description | Default Value |
|
||
|
|
| :------------- | :------------- | :------------- |
|
||
|
|
| <a id="copy_file-name"></a>name | Name of the rule. | none |
|
||
|
|
| <a id="copy_file-src"></a>src | A Label. The file or directory to make a copy of. (Can also be the label of a rule that generates a file or directory.) | none |
|
||
|
|
| <a id="copy_file-out"></a>out | Path of the output file, relative to this package. | none |
|
||
|
|
| <a id="copy_file-is_directory"></a>is_directory | treat the source file as a directory Workaround for https://github.com/bazelbuild/bazel/issues/12954 | <code>False</code> |
|
||
|
|
| <a id="copy_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. WARNING: If <code>allow_symlink</code> is True, <code>src</code> must also be executable. | <code>False</code> |
|
||
|
|
| <a id="copy_file-allow_symlink"></a>allow_symlink | A boolean. Whether to allow symlinking instead of copying. When False, the output is always a hard copy. When True, the output *can* be a symlink, but there is no guarantee that a symlink is created (i.e., at the time of writing, we don't create symlinks on Windows). Set this to True if you need fast copying and your tools can handle symlinks (which most UNIX tools can). | <code>False</code> |
|
||
|
|
| <a id="copy_file-kwargs"></a>kwargs | further keyword arguments, e.g. <code>visibility</code> | none |
|
||
|
|
|
||
|
|
|