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.

Sign up for GitHub

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

[installer] require rustup on the system #4668

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
+3 −2
Open

[installer] require rustup on the system #4668

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9c5194d
refactor: reorder the installer docs
nickfrosty Jan 28, 2025
2c0c59d
fix: require the rustup command
nickfrosty Jan 28, 2025
a4608b6
refactor: modified
nickfrosty Jan 30, 2025
d9d5aab
refactor: docs
nickfrosty Jan 30, 2025
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
4 changes: 2 additions & 2 deletions docs/src/cli/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

works for me


#### For Debian and Other Linux Distributions:

Expand Down Expand Up @@ -198,7 +198,7 @@ Install Homebrew (if not already installed), check "Install Homebrew" at
Install the necessary tools and libraries using Homebrew:

```bash
brew install rust pkg-config libudev protobuf llvm coreutils
brew install rust pkg-config libudev protobuf llvm coreutils rustup
```

Follow the instructions given at the end of the brew install command about
Expand Down
1 change: 1 addition & 0 deletions install/agave-install-init.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ main() {
need_cmd rm
need_cmd sed
need_cmd grep
need_cmd rustup
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given that we're now telling devs that need to install rustup, should this still be here ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

@steviez steviez Jan 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 ?


for arg in "$@"; do
case "$arg" in
Expand Down