The later sections of this guide describe the general layout of the the llvm source tree, a general layout of the the LLVM source-tree, a simple example using the LLVM tool chain, and links to find more information about LLVM or to get help via e-mail. @@ -83,7 +83,7 @@
See Setting up your environment on tips to - simplify working with the llvm front-end and compiled tools. See the + simplify working with the LLVM front-end and compiled tools. See the other sub-sections below for other useful details in working with LLVM, or go straight to Program Layout to learn about the layout of the source code tree. @@ -132,6 +132,7 @@ of LLVM (if the default values do not already match your system):
The LLVM make system sends most output files generated during the build into the directory defined by the variable LLVM_OBJ_DIR in - llvm/Makefile.config. - This can be either just your normal llvm source tree or some - other directory writable by you. You may wish to put object files on a - different filesystem either to keep them from being backed up or to speed - up local builds. + llvm/Makefile.config. This can be either just your normal LLVM + source tree or some other directory writable by you. You may wish to put + object files on a different filesystem either to keep them from being backed + up or to speed up local builds. -
If you do not wish to use a different location for object files, - just set this variable to ".". +
If you do not wish to use a different location for object files (building + into the source tree directly), just set this variable to ".".
Add the following lines to your .cshrc (or the corresponding lines to your .profile if you use a bourne shell derivative).
# Make the C front end easy to use...
- alias llvmgcc LLVMGCCDIR/bin/gcc
+ alias llvmgcc LLVMGCCDIR/bin/llvm-gcc
# Make the LLVM tools easy to use...
setenv PATH LLVM_OBJ_DIR/tools/Debug:${PATH}
@@ -179,7 +178,7 @@
The llvmgcc alias is useful because the C compiler is not
included in the CVS tree you just checked out.
- The other LLVM LLVM tools are part of the LLVM
+
The other LLVM tools are part of the LLVM
source base, and built when compiling LLVM. They will be built into the
LLVM_OBJ_DIR/tools/Debug directory.
@@ -187,17 +186,17 @@
Compiling the source code
- Every directory in the LLVM source tree includes a Makefile to build it,
- and any subdirectories that it contains. These makefiles require that you
- use gmake, instead of make to build them, but can
+
Every directory in the LLVM source tree includes a Makefile to
+ build it, and any subdirectories that it contains. These makefiles require
+ that you use gmake, instead of make to build them, but can
otherwise be used freely. To build the entire LLVM system, just enter the
top level llvm directory and type gmake. A few minutes
later you will hopefully have a freshly compiled toolchain waiting for you
in llvm/tools/Debug. If you want to look at the libraries that
were compiled, look in llvm/lib/Debug.
- If you get an error talking about a /shared directory, follow the
- instructions in the section about Setting Up Your
+ If you get an error talking about a /localhome directory, follow
+ the instructions in the section about Setting Up Your
Environment.
@@ -249,7 +248,7 @@
- llvm/include/llvm - This directory contains all of the LLVM
specific header files. This directory also has subdirectories for
- different portions of llvm: Analysis, CodeGen,
+ different portions of LLVM: Analysis, CodeGen,
Reoptimizer, Target, Transforms, etc...
- llvm/include/Support - This directory contains generic
@@ -276,7 +275,7 @@
- llvm/lib/ByteCode/
- This directory holds code for reading
and write LLVM bytecode.
-
- llvm/lib/CWrite/
- This directory implements the LLVM to C
+
- llvm/lib/CWriter/
- This directory implements the LLVM to C
converter.
- llvm/lib/Analysis/
- This directory contains a variety of
@@ -325,10 +324,10 @@
- as
- The assembler transforms the human readable
- llvm assembly to llvm bytecode.
+ LLVM assembly to LLVM bytecode.
-
- dis
- The disassembler transforms the llvm bytecode
- to human readable llvm assembly. Additionally it can convert LLVM
+
- dis
- The disassembler transforms the LLVM bytecode
+ to human readable LLVM assembly. Additionally it can convert LLVM
bytecode to C, which is enabled with the -c option.
- lli
- lli is the LLVM interpreter, which
@@ -361,7 +360,7 @@
frontend itself did not have to be modified to interface to a "wierd"
assembler.
-
- gccld
- gccld links together several llvm
+
- gccld
- gccld links together several LLVM
bytecode files into one bytecode file and does some optimization. It is
the linker invoked by the gcc frontend when multiple .o files need to be
linked together. Like gccas the command line interface of
@@ -369,7 +368,7 @@
interfacing with the GCC frontend.
-