build-script: add missing DocC dependency #61492
Merged
Conversation
This file contains hidden or 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
Without this dependency, passing both `--swiftdocc` and `--install-swiftdocc` to `build-script` causes it to crash with this stack trace:
```
Traceback (most recent call last):
File "./swift/utils/build-script", line 789, in <module>
exit_code = main()
File "./swift/utils/build-script", line 784, in main
return main_normal()
File "./swift/utils/build-script", line 740, in main_normal
invocation.execute()
File "./swift/utils/swift_build_support/swift_build_support/build_script_invocation.py", line 670, in execute
(self.impl_env, self.impl_args) = self.convert_to_impl_arguments()
File "./swift/utils/swift_build_support/swift_build_support/build_script_invocation.py", line 147, in convert_to_impl_arguments
for product_class in sum(list(self.compute_product_pipelines()[0]), []):
File "./swift/utils/swift_build_support/swift_build_support/build_script_invocation.py", line 664, in compute_product_pipelines
return builder.finalize(shouldInfer=self.args.infer_dependencies)
File "./swift/utils/swift_build_support/swift_build_support/productpipeline_list_builder.py", line 198, in finalize
result = self.infer()
File "./swift/utils/swift_build_support/swift_build_support/productpipeline_list_builder.py", line 157, in infer
build_graph.produce_scheduled_build(enabled_pipeline)[0]
File "./swift/utils/swift_build_support/swift_build_support/build_graph.py", line 150, in produce_scheduled_build
dag.set_root(entry)
File "./swift/utils/swift_build_support/swift_build_support/build_graph.py", line 95, in set_root
assert self.root is None
AssertionError
```
Apparently, the absence of this explicit dependency makes `build_graph.py` code think that `SwiftDocCRender` and `SwiftDocC` are independent root targets, which it can't handle. Making one a dependency of the other resolves the issue.
MaxDesiatov
requested review from
gottesmm,
etcwilde,
d-ronnqvist and
ethan-kusters
This comment was marked as outdated.
This comment was marked as outdated.
1 similar comment
|
@swift-ci please smoke test |
etcwilde
approved these changes
Oct 7, 2022
utils/swift_build_support/README.md
Outdated
| @@ -6,5 +6,5 @@ structures used by the Swift build script. | |||
| You may run unit tests for `swift_build_support` from the command line: | |||
|
|
|||
| ```sh | |||
| $ python utils/swift_build_support/run_tests.py | |||
There was a problem hiding this comment.
While a reasonable fix, this change looks unrelated
There was a problem hiding this comment.
makes sense, I'll submit it as a separate PR
ethan-kusters
approved these changes
Oct 8, 2022
MaxDesiatov
force-pushed
the
maxd/docc-missing-deps
branch
from
ec871f0 to
f6411c3
Compare
|
@swift-ci please smoke test and merge |
|
@swift-ci please test Windows |
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.
Without this dependency, passing both
--swiftdoccand--install-swiftdocctobuild-scriptcauses it to crash with this stack trace:Apparently, the absence of this explicit dependency makes
build_graph.pycode think thatSwiftDocCRenderandSwiftDocCare independent root targets, which it can't handle. Making one a dependency of the other resolves the issue.