Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[xcodegen] Update help text for --stdlib-swift #77807

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions utils/swift-xcodegen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
hamishknight marked this conversation as resolved.
Show resolved Hide resolved
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
Expand Down
9 changes: 7 additions & 2 deletions utils/swift-xcodegen/Sources/swift-xcodegen/Options.swift
Original file line number Diff line number Diff line change
Expand Up @@ -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
hamishknight marked this conversation as resolved.
Show resolved Hide resolved
compiler, which may support features not yet supported by the Swift
compiler in Xcode's toolchain.
"""
)
var addStdlibSwift: Bool = false
Expand Down