Description
| Previous ID | SR-8863 |
| Radar | None |
| Original Reporter | @beccadax |
| Type | Improvement |
Additional Detail from JIRA
| Votes | 0 |
| Component/s | Project Infrastructure |
| Labels | Improvement, Documentation, SourceCompatibility |
| Assignee | None |
| Priority | Medium |
md5: f69a3d7b0c6ebf36c2c7d9ba94ae51d4
Issue Description:
The README in apple/swift-source-compat-suite explains how to use runner.py locally and even points out the --swiftc option, but doesn't explain how to build a suitable Swift compiler in development; nor does the --help text of the repository's tools. "utils/build-script -bp" is not enough by itself because it builds swiftpm in a separate folder from the Swift compiler, and the compiler can't find the swift-package command. If --swift-branch can be used to build and use a compiler with local changes, none of the tools explain how.
The README's "Building Projects" section should include appropriate instructions for this case, or the --help text of runner.py and/or reproduce.py should be edited to explain the appropriate options.