docs: clarify write_source_files output constraint #498
+4
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
For both the "write_source_files" rule's "files" attribute and the "write_source_file" rule's "out_file" attribute, we ensure that the destination files and directories to which we'll write sit within the same containing Bazel package as the Bazel target requesting this writing. Clarify the documentation for each attribute to make it clear that we're constraining the destinations and not the sources of the content to be written.
|
|
kormide
reviewed
Aug 23, 2023
kormide
approved these changes
Aug 23, 2023
seh
force-pushed
the
correct-write-source-files-doc
branch
from
8b76b5f
to
87ed554
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For both the
write_source_filesrule's "files" attribute and thewrite_source_filerule's "out_file" attribute, we ensure that the destination files and directories to which we'll write sit within the same containing Bazel package as the Bazel target requesting this writing. Clarify the documentation for each attribute to make it clear that we're constraining the destinations and not the sources of the content to be written.See #28 for the original documentation's arrival (specifically #28 (comment)), and the discussion in the "rules" channel of the "Bazel" Slack workspace that led to this proposed change.
Type of change
Documentation
For changes visible to end-users
Test plan