-
Notifications
You must be signed in to change notification settings - Fork 10.6k
Clarify GettingStarted.md for macOS #86008
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
base: main
Are you sure you want to change the base?
Conversation
|
@swift-ci Please smoke test |
| 1. Install Xcode. The minimum required version is specified in the node | ||
| information on <https://ci.swift.org>, may change frequently, and is often | ||
| a beta release. | ||
| 1. Install [Ninja][] and [Sccache][]: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
out of curiosity, why is the Ninja stuff being removed here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because the build process checks out and builds ninja for you, there's no need to do it yourself. You can if you want, though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And neither sccache nor homebrew is a requirement either. You just need Xcode and CMake.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because the build process checks out and builds ninja for you
Does it by default? I don’t have a ninja clone in any of my checkouts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You just need Xcode and CMake.
CMake was previously removed from this document (in #83063 by @MaxDesiatov).
As with ninja, CMake will be built from source, but I did encounter two issues:
-
utils/build-script --cleanfailed to rebuild CMake (as far as I remember). -
utils/run-testcouldn't find CMake (I had to manually add it to the PATH).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, ninja is the preferred tool for incremental builds AFAIC. I don’t think the build script installs it your PATH.
| This step is not required, but it speeds up rebuilds by caching build artifacts. | ||
| [Xcode]: https://developer.apple.com/xcode/resources/ | ||
| [Ninja]: https://ninja-build.org |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: the link might still be useful to include somewhere even if the tool is installed automatically
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We had certain ninja compatibility problem's too, so I'd prefer we don't mislead users telling them to install a wrong version.
MaxDesiatov
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The CMake installation step needs to be removed as Homebrew doesn't supply CMake 3.x and CMake 4.x is not compatible with our build system. Additionally, build-script will build and cache a compatible version for you already.
No description provided.