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

Docs: Add troubleshooting tips #259

Merged
merged 1 commit into from
Aug 23, 2021
Merged

Docs: Add troubleshooting tips #259

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 15 additions & 2 deletions book/src/build_and_install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,24 @@

## Prerequisites
To be able to build the source code, you will need to [install Rust](https://www.rust-lang.org/tools/install)
and LLVM 11 along with the standard build tools (`build-essential`) and `libz-dev` on your machine.
For Linux the package manager version of LLVM (`llvm-11-dev` for apt) will work fine, for Windows, you need a
and LLVM 11, along with the standard build tools (`build-essential`) and `libz-dev` on your machine.
For Linux the package manager version of LLVM (e.g. `llvm-11-dev` for apt) will work fine, for Windows, you need a
[special build](https://github.com/ghaith/llvm-package-windows/releases/tag/v11.0.1). If you want to
clone and work on the repository, you'll also need _git_.

### Tips for troubleshooting
* Because of weak compatibility guarantees of the LLVM API, the LLVM installation must exactly match the
major version of the `llvm-sys` crate. Currently you will need to install LLVM 11 to satisfy this constraint.
[Read more](https://crates.io/crates/llvm-sys)
* To avoid installation conflicts on Linux/Ubuntu, make sure you don't have a default installation available
(like just installing `llvm-dev`), which may break things. If you do, make sure you have set
the appropriate environment variable (`LLVM_SYS_110_PREFIX=/usr/lib/llvm-11` for LLVM 11), so
the build of the `llvm-sys` crate knows what files to grab.
* If you get an error stating that the `native static library 'Polly'` cannot be found, you might want to
install the `libclang-common-11-dev` package, which includes this library in the form of a static library.
Alternatively, building LLVM from source should also provide you with that file. Building from source may
take a while, though.

## Cloning the repository
On your local computer, open up a shell and clone the repository.
```bash
Expand Down