Remove mentions of build-toolchain from README.md
#69130
+1
−60
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
While `build-toolchain` is a script that runs on CI, we haven't found it to be reliable when building locally. Its default settings are sufficiently different from what is recommended in the existing `docs/GettingStarted.md` guide. We've received multiple reports from potential first-time contributors who are unable to build locally with `build-toolchain`, but for whom `utils/build-script` did work. Additionally, there doesn't seem to be a consensus that building a toolchain package is the best and the quickest way to try out a newly built compiler in Xcode. In a subsequent PR we should recommend the usage of `SWIFT_EXEC` or downloading a toolchain as a result of `@swift-ci build toolchain` CI triggers instead.
MaxDesiatov
requested review from
xedin,
shahmishal,
egorzhdan,
hborla and
AnthonyLatsis
MaxDesiatov
changed the title
build-toolchain in README.mdbuild-toolchain from README.md
xedin
approved these changes
Oct 12, 2023
|
build-toolchain script is not used in CI, this was added by contributor to help reproduce the toolchain steps locally. I would recommend adding this info somewhere if we don't want it in README. To be clear, I do agree it should not be in the README as most people don't need to build the full toolchain. |
|
@swift-ci smoke test and merge |
|
@swift-ci smoke test linux |
|
@swift-ci smoke test macos |
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.
While
build-toolchainis a script that runs on CI, we haven't found it to be reliable when building locally. Its default settings are sufficiently different from what is recommended in the existingdocs/GettingStarted.mdguide. We've received multiple reports from potential first-time contributors who are unable to build locally withbuild-toolchain, but for whomutils/build-scriptdid work.Additionally, there doesn't seem to be a consensus that building a toolchain package is the best and the quickest way to try out a newly built compiler in Xcode. In a subsequent PR we should recommend the usage of
SWIFT_EXECor downloading a toolchain as a result of@swift-ci build toolchainCI triggers instead.