diff --git a/docs/write_source_files.md b/docs/write_source_files.md index 1e7d4341f..1a253bfd2 100644 --- a/docs/write_source_files.md +++ b/docs/write_source_files.md @@ -25,7 +25,7 @@ To disable the exists check and up-to-date test set `diff_test` to `False`. | :------------- | :------------- | :------------- | | name | Name of the runnable target that creates or updates the source tree file or directory. | none | | in_file | File or directory to use as the desired content to write to out_file.

This is typically a file or directory output of another target. If in_file is a directory then entire directory contents are copied. | None | -| out_file | The file or directory to write to in the source tree. Must be within the same bazel package as the target. | None | +| out_file | The file or directory to write to in the source tree. Must be within the same containing Bazel package as this target. | None | | executable | Whether source tree file or files within the source tree directory written should be made executable. | False | | additional_update_targets | List of other write_source_files or write_source_file targets to call in the same run. | [] | | suggested_update_target | Label of the write_source_files or write_source_file target to suggest running when files are out of date. | None | @@ -136,7 +136,7 @@ NOTE: If you run formatters or linters on your codebase, it is advised that you | Name | Description | Default Value | | :------------- | :------------- | :------------- | | name | Name of the runnable target that creates or updates the source tree files and/or directories. | none | -| files | A dict where the keys are files or directories in the source tree to write to and the values are labels pointing to the desired content, typically file or directory outputs of other targets.

Source tree files and directories must be within the same bazel package as the target. | {} | +| files | A dict where the keys are files or directories in the source tree to write to and the values are labels pointing to the desired content, typically file or directory outputs of other targets.

Destination files and directories must be within the same containing Bazel package as this target. | {} | | executable | Whether source tree files written should be made executable.

This applies to all source tree files written by this target. This attribute is not propagated to additional_update_targets.

To set different executable permissions on different source tree files use multiple write_source_files targets. | False | | additional_update_targets | List of other write_source_files or write_source_file targets to call in the same run. | [] | | suggested_update_target | Label of the write_source_files or write_source_file target to suggest running when files are out of date. | None | diff --git a/lib/private/write_source_file.bzl b/lib/private/write_source_file.bzl index 8f2c2692d..2789e033c 100644 --- a/lib/private/write_source_file.bzl +++ b/lib/private/write_source_file.bzl @@ -34,7 +34,7 @@ def write_source_file( This is typically a file or directory output of another target. If `in_file` is a directory then entire directory contents are copied. - out_file: The file or directory to write to in the source tree. Must be within the same bazel package as the target. + out_file: The file or directory to write to in the source tree. Must be within the same containing Bazel package as this target. executable: Whether source tree file or files within the source tree directory written should be made executable. diff --git a/lib/write_source_files.bzl b/lib/write_source_files.bzl index 82f6c7b92..f93a09d03 100644 --- a/lib/write_source_files.bzl +++ b/lib/write_source_files.bzl @@ -102,7 +102,7 @@ def write_source_files( files: A dict where the keys are files or directories in the source tree to write to and the values are labels pointing to the desired content, typically file or directory outputs of other targets. - Source tree files and directories must be within the same bazel package as the target. + Destination files and directories must be within the same containing Bazel package as this target. executable: Whether source tree files written should be made executable.