fix(#5566): updated two docs to make build steps clearer #5568
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
Clarified that the `agave-install` command shown is ONLY for installing the `test` or `prod` versions, and expects to be building from a downloaded release source archive, but can be managed by switching to a tagged release.
Added section 3a, describing the dependency install steps to get this installed on a macOS machine. Also changed wording on the accompanying NOTE quote.
|
|
||
| # Include the installed bins in your PATH | ||
| $ export PATH=$PATH:$PWD/bin | ||
| $ ./cargo build |
There was a problem hiding this comment.
cargo-install-all.sh contains building so extra ./cargo build shouldn't be applied
There was a problem hiding this comment.
@sonicfromnewyoke I put that there mostly for clarity that from this point the developer can start running the ./cargo build again as they make changes. But if I misunderstood the use case of a local cargo definition then I can remove it?
|
|
||
| ```bash | ||
| $ # Install build dependencies | ||
| $ brew install pkg-config libudev protobuf llvm coreutils |
There was a problem hiding this comment.
wdyt about moving this line a lil bit higher, just after On Fedora: paragraph?
There was a problem hiding this comment.
Yeah good point, that makes more sense and flows better
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.
Problem
See 5566 for clearer description.
Basically there's a lack of clarity in some of the build instructions for macOS.
Summary of Changes
This adds some additional clarity on what dependencies are needed to build on macOS and how the
./docs/src/cli/install.mdare specifically for buildingtest/prodversions.Fixes #5566