From ac4d52d5c351e92823c1467133e515f6423b8ae2 Mon Sep 17 00:00:00 2001 From: Hamish Knight Date: Fri, 22 Nov 2024 15:49:19 +0000 Subject: [PATCH 1/2] [xcodegen] Update help text for `--stdlib-swift` Clarify why a development snapshot is needed for stdlib Swift targets. --- utils/swift-xcodegen/README.md | 9 +++++++-- .../swift-xcodegen/Sources/swift-xcodegen/Options.swift | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/utils/swift-xcodegen/README.md b/utils/swift-xcodegen/README.md index a36c8bae5dfe4..0b0150abdf49d 100644 --- a/utils/swift-xcodegen/README.md +++ b/utils/swift-xcodegen/README.md @@ -76,8 +76,13 @@ PROJECT CONFIGURATION: Generate a target for C/C++ files in the standard library (default: --stdlib) --stdlib-swift/--no-stdlib-swift Generate targets for Swift files in the standard library. This requires - using Xcode with a main development snapshot (and as such is disabled - by default). (default: --no-stdlib-swift) + using Xcode with a main development Swift snapshot, and as such is + disabled by default. + + A development snapshot is necessary to avoid spurious build/live issues + due to fact that the the stdlib is built using the just-built Swift + compiler, which may support features not yet supported by the Swift + compiler in Xcode's toolchain. (default: --no-stdlib-swift) --test-folders/--no-test-folders Add folder references for test files (default: --test-folders) --unittests/--no-unittests diff --git a/utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift b/utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift index 9abc559ce4980..ec59cd3f1e80d 100644 --- a/utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift +++ b/utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift @@ -164,8 +164,13 @@ struct ProjectOptions: ParsableArguments { name: .customLong("stdlib-swift"), inversion: .prefixedNo, help: """ Generate targets for Swift files in the standard library. This requires - using Xcode with a main development snapshot (and as such is disabled - by default). + using Xcode with a main development Swift snapshot, and as such is + disabled by default. + + A development snapshot is necessary to avoid spurious build/live issues + due to fact that the the stdlib is built using the just-built Swift + compiler, which may support features not yet supported by the Swift + compiler in Xcode's toolchain. """ ) var addStdlibSwift: Bool = false From b0d91b016c43b7b9993a16ca042eb07c0d7a8262 Mon Sep 17 00:00:00 2001 From: Hamish Knight Date: Fri, 22 Nov 2024 16:00:09 +0000 Subject: [PATCH 2/2] Fix typo Co-authored-by: Jamie <2119834+jamieQ@users.noreply.github.com> --- utils/swift-xcodegen/README.md | 2 +- utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/utils/swift-xcodegen/README.md b/utils/swift-xcodegen/README.md index 0b0150abdf49d..9088a4510d38b 100644 --- a/utils/swift-xcodegen/README.md +++ b/utils/swift-xcodegen/README.md @@ -80,7 +80,7 @@ PROJECT CONFIGURATION: disabled by default. A development snapshot is necessary to avoid spurious build/live issues - due to fact that the the stdlib is built using the just-built Swift + due to the fact that the the stdlib is built using the just-built Swift compiler, which may support features not yet supported by the Swift compiler in Xcode's toolchain. (default: --no-stdlib-swift) --test-folders/--no-test-folders diff --git a/utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift b/utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift index ec59cd3f1e80d..d5cb587dd470a 100644 --- a/utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift +++ b/utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift @@ -168,7 +168,7 @@ struct ProjectOptions: ParsableArguments { disabled by default. A development snapshot is necessary to avoid spurious build/live issues - due to fact that the the stdlib is built using the just-built Swift + due to the fact that the the stdlib is built using the just-built Swift compiler, which may support features not yet supported by the Swift compiler in Xcode's toolchain. """