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

Jump to bottom

Clarify recommended LLVM minimum version and library dependencies #706

Merged
merged 1 commit into from May 9, 2017
Merged

Clarify recommended LLVM minimum version and library dependencies #706

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
26 changes: 20 additions & 6 deletions docs/user/setup.rst
View file
Open in desktop
Expand Up @@ -7,7 +7,7 @@ This is what you will be doing, in a nutshell:

* installation of sbt
* installation of LLVM and Clang
* installation of Boehm GC
* installation of native libraries

Installing sbt
--------------
Expand All @@ -18,12 +18,26 @@ for instructions for your OS.
Please note that you'll need Java 8 or more recent to use the Scala Native
toolchain.

Installing LLVM, Clang and Boehm GC
-----------------------------------
Installing LLVM, Clang and native libraries
-------------------------------------------

Boehm GC and LLVM (that includes Clang) are Scala Native's only external
dependencies. Here are install instructions for a number of operating
systems Scala Native has been used with:
Scala Native requires Clang, which is part of the LLVM toolchain. The
recommended LLVM version is 3.7 or newer, however, the Scala Native sbt
plugin uses feature detection to discover the installed version of Clang
so older versions may also work.

In addition, the native Scala runtime and Java API implementation
require the Boehm garbage collector and the RE2 regular expression
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks great! We might as well specify the version numbers for completeness.

engine. Both the native library and header files must be provided at
build time.

.. note::

Some package managers provide the library header files in separate
`-dev` packages.

Here are install instructions for a number of operating systems Scala
Native has been used with:

Ubuntu::

Expand Down