Re-organize the LLVM build instructions #6059
Merged
Conversation
This file contains 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
rtfeldman
reviewed
Nov 22, 2023
BUILDING_FROM_SOURCE.md
Outdated
| @@ -104,25 +104,33 @@ For any OS, you can use [`zigup`](https://github.com/marler8997/zigup) to manage | |||
| If you prefer a package manager, you can try the following: | |||
|
|
|||
| - For MacOS, you can install with `brew install [email protected]` | |||
| - For, Ubuntu, you can use Snap, you can install with `snap install zig --classic --beta` | |||
| - For systems with Snap, you can install with `snap install zig --classic --beta` | |||
There was a problem hiding this comment.
I think referencing Ubuntu by name here is probably helpful to people running Ubuntu.
How about this?
Suggested change
| - For systems with Snap, you can install with `snap install zig --classic --beta` | |
| - For systems with Snap (such as Ubuntu), you can install with `snap install zig --classic --beta` |
rtfeldman
reviewed
Nov 22, 2023
BUILDING_FROM_SOURCE.md
Outdated
| You may also need to manually specify a prefix env var like so: | ||
|
|
||
| ```sh | ||
| export LLVM_SYS_160_PREFIX=/usr/local/opt/llvm@16 |
There was a problem hiding this comment.
Hm, shouldn't this also use brew --prefix? 🤔 e.g.
Suggested change
| export LLVM_SYS_160_PREFIX=/usr/local/opt/llvm@16 | |
| export LLVM_SYS_160_PREFIX=$(brew --prefix llvm@16) |
- `zig` needs `lib` directory - `llvm` needs development headers - Keep installation instructions together - Group by platform - No longer split installation and debugging instructions
stefanv
force-pushed
the
organize-llvm-build-instructions
branch
from
37db031
to
6883c76
Compare
|
Thanks for the review @rtfeldman; I've updated the PR accordingly. |
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.
zigneedslibdirectoryllvmneeds development headers