diff options
author | Carlo Zancanaro <carlo@pc-4w14-0.cs.usyd.edu.au> | 2012-10-15 17:10:06 +1100 |
---|---|---|
committer | Carlo Zancanaro <carlo@pc-4w14-0.cs.usyd.edu.au> | 2012-10-15 17:10:06 +1100 |
commit | be1de4be954c80875ad4108e0a33e8e131b2f2c0 (patch) | |
tree | 1fbbecf276bf7c7bdcbb4dd446099d6d90eaa516 /clang/INSTALL.txt | |
parent | c4626a62754862d20b41e8a46a3574264ea80e6d (diff) | |
parent | f1bd2e48c5324d3f7cda4090c87f8a5b6f463ce2 (diff) |
Merge branch 'master' of ssh://bitbucket.org/czan/honours
Diffstat (limited to 'clang/INSTALL.txt')
-rw-r--r-- | clang/INSTALL.txt | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/clang/INSTALL.txt b/clang/INSTALL.txt new file mode 100644 index 0000000..e8e3209 --- /dev/null +++ b/clang/INSTALL.txt @@ -0,0 +1,49 @@ +//===----------------------------------------------------------------------===// +// Clang Installation Instructions +//===----------------------------------------------------------------------===// + +These instructions describe how to build and install Clang. + +//===----------------------------------------------------------------------===// +// Step 1: Organization +//===----------------------------------------------------------------------===// + +Clang is designed to be built as part of an LLVM build. Assuming that the LLVM +source code is located at $LLVM_SRC_ROOT, then the clang source code should be +installed as: + + $LLVM_SRC_ROOT/tools/clang + +The directory is not required to be called clang, but doing so will allow the +LLVM build system to automatically recognize it and build it along with LLVM. + +//===----------------------------------------------------------------------===// +// Step 2: Configure and Build LLVM +//===----------------------------------------------------------------------===// + +Configure and build your copy of LLVM (see $LLVM_SRC_ROOT/GettingStarted.html +for more information). + +Assuming you installed clang at $LLVM_SRC_ROOT/tools/clang then Clang will +automatically be built with LLVM. Otherwise, run 'make' in the Clang source +directory to build Clang. + +//===----------------------------------------------------------------------===// +// Step 3: (Optional) Verify Your Build +//===----------------------------------------------------------------------===// + +It is a good idea to run the Clang tests to make sure your build works +correctly. From inside the Clang build directory, run 'make test' to run the +tests. + +//===----------------------------------------------------------------------===// +// Step 4: Install Clang +//===----------------------------------------------------------------------===// + +From inside the Clang build directory, run 'make install' to install the Clang +compiler and header files into the prefix directory selected when LLVM was +configured. + +The Clang compiler is available as 'clang' and supports a gcc like command line +interface. See the man page for clang (installed into $prefix/share/man/man1) +for more information. |