xref: /aosp_15_r20/external/bazel-skylib/rules/copy_file.bzl (revision bcb5dc7965af6ee42bf2f21341a2ec00233a8c8a)
1*bcb5dc79SHONG Yifan# Copyright 2019 The Bazel Authors. All rights reserved.
2*bcb5dc79SHONG Yifan#
3*bcb5dc79SHONG Yifan# Licensed under the Apache License, Version 2.0 (the "License");
4*bcb5dc79SHONG Yifan# you may not use this file except in compliance with the License.
5*bcb5dc79SHONG Yifan# You may obtain a copy of the License at
6*bcb5dc79SHONG Yifan#
7*bcb5dc79SHONG Yifan#    http://www.apache.org/licenses/LICENSE-2.0
8*bcb5dc79SHONG Yifan#
9*bcb5dc79SHONG Yifan# Unless required by applicable law or agreed to in writing, software
10*bcb5dc79SHONG Yifan# distributed under the License is distributed on an "AS IS" BASIS,
11*bcb5dc79SHONG Yifan# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12*bcb5dc79SHONG Yifan# See the License for the specific language governing permissions and
13*bcb5dc79SHONG Yifan# limitations under the License.
14*bcb5dc79SHONG Yifan
15*bcb5dc79SHONG Yifan"""A rule that copies a file to another place.
16*bcb5dc79SHONG Yifan
17*bcb5dc79SHONG Yifannative.genrule() is sometimes used to copy files (often wishing to rename them).
18*bcb5dc79SHONG YifanThe 'copy_file' rule does this with a simpler interface than genrule.
19*bcb5dc79SHONG Yifan
20*bcb5dc79SHONG YifanThe rule uses a Bash command on Linux/macOS/non-Windows, and a cmd.exe command
21*bcb5dc79SHONG Yifanon Windows (no Bash is required).
22*bcb5dc79SHONG Yifan"""
23*bcb5dc79SHONG Yifan
24*bcb5dc79SHONG Yifanload(
25*bcb5dc79SHONG Yifan    "//rules/private:copy_file_private.bzl",
26*bcb5dc79SHONG Yifan    _copy_file = "copy_file",
27*bcb5dc79SHONG Yifan)
28*bcb5dc79SHONG Yifan
29*bcb5dc79SHONG Yifancopy_file = _copy_file
30