build: define build path structure in BuildSystemProvider.Kind #8298
+13
−5
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
1 task
bkhouri
commented
Feb 19, 2025
bkhouri
requested review from
bnbarham,
MaxDesiatov,
jakepetroules,
xedin,
dschaefer2,
shawnhyam,
bripeticca,
plemarquand and
owenv
as code owners
There are a few places that check the BuildSystemProvider.Kind is Xcode to determine the build directory structure. With the upcoming Swift Build integration, which uses the "Xcode path" structure, we would need to update all instances to check the two build system provider kinds. Add an extension on the BuildSystemProvider.Kind that create a boolean variable `useXcodeBuildEngine`, which determines whether the build system should use the xcode path structure or not. In addition, update the code that requires a "isXcodeBuildSystemEnabled" to return this build system provider variable. This will hopefully help address swiftlang#8272 when swiftlang#8271, where it adds `case .swiftbuild: return true` to the `useXcodeBuildEngine`
bkhouri
force-pushed
the
t/main/gh8272_rdar_144023142_partial_fix
branch
from
87d8887 to
a926008
Compare
|
@swift-ci please test |
MaxDesiatov
reviewed
Feb 25, 2025
| @@ -168,6 +168,14 @@ public struct BuildSystemProvider { | |||
| } | |||
| } | |||
|
|
|||
| extension BuildSystemProvider.Kind { | |||
| public var useXcodeBuildEngine: Bool { | |||
There was a problem hiding this comment.
This should be spelled as usesXcodeBuildEngine to conform to the API Design Guidelines: https://www.swift.org/documentation/api-design-guidelines/#strive-for-fluent-usage
Uses of Boolean methods and properties should read as assertions about the receiver when the use is nonmutating, e.g.
x.isEmpty,line1.intersects(line2).
Suggested change
| public var useXcodeBuildEngine: Bool { | |
| public var usesXcodeBuildEngine: Bool { |
MaxDesiatov
reviewed
Feb 25, 2025
There was a problem hiding this comment.
I'm not sure if usesXcodeBuildEngine is more readable than == .xcode. If this were more than an enum with two cases (or there were plans to make it more complex in the future), one might argue that the check is complex enough, but for an enum as trivial as this I don't see much benefit.
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.
There are a few places that check the BuildSystemProvider.Kind is Xcode to determine the build directory structure. With the upcoming Swift Build integration, which uses the "Xcode path" structure, we would need to update all instances to check the two build system provider kinds.
Add an extension on the BuildSystemProvider.Kind that create a boolean variable
useXcodeBuildEngine, which determines whether the build system should use the xcode path structure or not. In addition, update the code that requires a "isXcodeBuildSystemEnabled" to return this build system provider variable.This will hopefully help address #8272 when #8271 is merged and added
case .swiftbuild: return trueto theuseXcodeBuildEngine