[installer] require rustup on the system #4668
Conversation
docs/src/cli/install.md
Outdated
|
|
||
| ## Prerequisites | ||
|
|
||
| Before installing the Solana CLI tools (either the prebuilt binaries or building from source), make sure to install the following prerequisites: |
There was a problem hiding this comment.
I think there is some nuance here for different groups of people who might be using the CLI:
- Developers
- "Regular" users who may just be doing simple stuff like using the CLI for transfers or native staking
The first group will absolutely want these tools, but the latter might be led to believe they need to install a bunch of things they don't need.
There was a problem hiding this comment.
that's fair. I could clarify this prereqs section and header that its for people who want to build from source or develop programs
There was a problem hiding this comment.
I went ahead and just moved the prereqs section back under "building from source"
docs/src/cli/install.md
Outdated
| @@ -154,7 +154,7 @@ installed on your system. | |||
|
|
|||
| ### Prerequisites | |||
|
|
|||
| Before building from source, make sure to install the following prerequisites: | |||
| Before building from source, or developing Solana programs, make sure to install the following prerequisites: | |||
There was a problem hiding this comment.
With the added bit about developing programs, this sentence sounds a little "off" to me now. What do you think about flipping it around:
Install the following prerequisites before building from source or developing Solana programs:
Looking in this file, I see several other sentences that start with "Install Yinstead ofBefore X, install Y` so I think my suggestion would make this line more consistent with the overall doc
| @@ -50,6 +50,7 @@ main() { | |||
| need_cmd rm | |||
| need_cmd sed | |||
| need_cmd grep | |||
| need_cmd rustup | |||
There was a problem hiding this comment.
Given that we're now telling devs that need to install rustup, should this still be here ?
There was a problem hiding this comment.
evne thought the docs state to install it, if a dev does not have it installed the platform tools code will silently fail to create the solana toolchain. having the command check prevents it
There was a problem hiding this comment.
Edit: My previous wording in this comment was unclear.
What is the result of this change ? Will rustup get automatically installed if it was not already? Or, will it now raise a warning and/or error out if rustup is unavailable ?
Problem
the agave installer ultimately requires having rustup installed in order to link the platform tools to become the
solanatoolchain, but does not check for it. so if a developer installs rust viabrewor some other means, they may not haverustupavailable on their machine. and ultimately run into issues with the solana rust toolchain not being availableSummary of Changes
agave-install-initscript for rustupFixes #4651