diff options
Diffstat (limited to 'helpers/README.txt')
| -rw-r--r-- | helpers/README.txt | 47 |
1 files changed, 29 insertions, 18 deletions
diff --git a/helpers/README.txt b/helpers/README.txt index 1875f7a..9577192 100644 --- a/helpers/README.txt +++ b/helpers/README.txt @@ -34,28 +34,39 @@ This type of repo is meant for dev boards, benchmarks and stress tests. Environment Variables --------------------- -These scripts rely on three environment variables: - -LLVM_SRC : The path to the LLVM source directory. All other repos will be - checked out relative to it in ($LLVM_SRC/../<project>) and linked - to the right place inside $LLVM_SRC. It is recommended that you - set it to a place where all source dirs will be, and only those, - for example ~/devel/llvm/src/llvm. -LLVM_BLD : The path to the (out-of-tree) directory for the release+asserts - build. It is recommended that you set it two levels down from the - source dirs, so you can have multiple build directories (debug, - no-asserts, lld, etc), example ~/devel/llvm/build/llvm. -LLVM_GITRW : Git-Read-Write mode, which also means using Git-Svn or not. - Values can be 'yes' or 'no'. +In order to use these scripts, you will have to set the following environment +variables: + +LLVM_ROOT : A path where the scripts can checkout the LLVM & related + repositories and create build directories for them +LLVM_GITRW : Git-Read-Write mode, which also means using Git-Svn or not. + Values can be 'yes' or 'no'. +LLVM_GITUSER : User for 'origin'. +LLVM_SVNUSER : User for the upstream SVN repo (only if LLVM_GITRW = 'yes'). + +Based on these variables, the llvm-env script sets up the environment needed by +the other helper scripts. You should usually source llvm-env before running any +of the helper scripts. Dependencies ------------ In order to fully use these scripts, you're going to need to install a few dependencies. Since people use different Linux distributions, the scripts -don't even try to install that automatically. The dependencies are: - -Scripts/Build: libjson-perl cmake ninja-build perl python2.7 ccache -LLVM: libxml2-dev zlib1g-dev libtinfo-dev python-sphinx binutils-gold -Test-Suite: python-virtualenv bison groff gawk +don't even try to install that automatically. + +The scripts themselves require Git-SVN and a version of Git that can handle +worktrees (e.g. git 2.5.0, may work with earlier versions too). + +The requirements for LLVM and the related subprojects are listed in the upstream +documentation: +llvm: http://llvm.org/docs/GettingStarted.html#requirements +clang: http://clang.llvm.org/get_started.html +compiler-rt: http://compiler-rt.llvm.org/ +lld: http://lld.llvm.org/getting_started.html +lldb: http://lldb.llvm.org/build.html +libcxx: http://libcxx.llvm.org/docs/BuildingLibcxx.html +libcxxabi: http://libcxxabi.llvm.org/ +test-suite: http://llvm.org/docs/TestingGuide.html#requirements +lnt: http://llvm.org/docs/lnt/intro.html?highlight=requirements |