From 86a3a486971fb9b56f1d92f7dcb6ce17e9ec55c7 Mon Sep 17 00:00:00 2001
From: John Criswell
Date: Thu, 18 Dec 2003 16:43:17 +0000
Subject: Merged in RELEASE_11.
llvm-svn: 10516
---
llvm/docs/GettingStarted.html | 109 ++++++++++++++++++++++++++++++++----------
1 file changed, 83 insertions(+), 26 deletions(-)
(limited to 'llvm/docs/GettingStarted.html')
diff --git a/llvm/docs/GettingStarted.html b/llvm/docs/GettingStarted.html
index 82860967133..849aa973582 100644
--- a/llvm/docs/GettingStarted.html
+++ b/llvm/docs/GettingStarted.html
@@ -129,7 +129,8 @@ from the LLVM suite.
header files for the default platform. Useful options include:
- --with-llvmgccdir=directory
-
Specify where the LLVM GCC frontend is installed.
+ Specify the full pathname of where the LLVM GCC frontend is
+ installed.
- --enable-spec2000=directory
Enable the SPEC2000 benchmarks for testing. The SPEC2000
benchmarks should be available in
@@ -181,24 +182,55 @@ software you will need.
- Linux on x86 (Pentium and above)
- - Approximately 760 MB of Free Disk Space
+
- Approximately 918 MB of Free Disk Space
- - Source code: 30 MB
- - Object code: 670 MB
- - GCC front end: 60 MB
+ - Source code: 28 MB
+ - Object code: 850 MB
+ - GCC front end: 40 MB
-
+
+
+
+
Solaris on SparcV9 (Ultrasparc)
- - Approximately 1.24 GB of Free Disk Space
+
- Approximately 1.52 GB of Free Disk Space
- - Source code: 30 MB
- - Object code: 1000 MB
- - GCC front end: 210 MB
+ - Source code: 28 MB
+ - Object code: 1470 MB
+ - GCC front end: 50 MB
-
+
+
+
+
+
+ FreeBSD on x86 (Pentium and above)
+
+ - Approximately 918 MB of Free Disk Space
+
+ - Source code: 28 MB
+ - Object code: 850 MB
+ - GCC front end: 40 MB
+
+
+
+
+
+
+ MacOS X on PowerPC
+
+ - No native code generation
+
- Approximately 1.20 GB of Free Disk Space
+
+ - Source code: 28 MB
+ - Object code: 1160 MB
+ - GCC front end: 40 MB
+
+
+
The LLVM suite may compile on other platforms, but it is not
@@ -252,7 +284,6 @@ LLVM:
-
The remainder of this guide is meant to get you up and running with
LLVM and to give you some basic information about the LLVM environment.
A complete guide to installation is provided in the
@@ -347,22 +378,31 @@ You can set these on the command line, or better yet, set them in your
If you have the LLVM distribution, you will need to unpack it before you
-can begin to compile it. LLVM is distributed as a set of three files. Each
+can begin to compile it. LLVM is distributed as a set of two files: the LLVM
+suite and the LLVM GCC front end compiled for your platform. Each
file is a TAR archive that is compressed with the gzip program.
- The three files are as follows:
+
The files are as follows:
- - llvm.tar.gz
+
- llvm-1.1.tar.gz
- This is the source code to the LLVM suite.
-
- cfrontend.sparc.tar.gz
+
- cfrontend-1.1.sparc-sun-solaris2.8.tar.gz
- This is the binary release of the GCC front end for Solaris/Sparc.
-
- cfrontend.x86.tar.gz
+
- cfrontend-1.1.i686-redhat-linux-gnu.tar.gz
- This is the binary release of the GCC front end for Linux/x86.
+
+
+
- cfrontend-1.1.i386-unknown-freebsd5.1.tar.gz
+
- This is the binary release of the GCC front end for FreeBSD/x86.
+
+
+
- cfrontend-1.1.powerpc-apple-darwin7.0.0.tar.gz
+
- This is the binary release of the GCC front end for MacOS X/PPC.
@@ -390,6 +430,20 @@ follows:
directory and fully populate it with the LLVM source code, Makefiles,
test directories, and local copies of documentation files.
+
+If you want to get a specific release (as opposed to the most recent revision),
+you can specify a label. The following releases have the following label:
+
+ -
+ Release 1.1: RELEASE_11
+
+
+ -
+ Release 1.0: RELEASE_1
+
+
+
+
Note that the GCC front end is not included in the CVS repository. You
should have downloaded the binary distribution for your platform.
@@ -411,12 +465,12 @@ location must be specified when the LLVM suite is configured.
- cd where-you-want-the-front-end-to-live
- - gunzip --stdout cfrontend.platform.tar.gz | tar -xvf
+
- gunzip --stdout cfrontend-version.platform.tar.gz | tar -xvf
-
-If you are on a Sparc/Solaris machine, you will need to fix the header
-files:
+If you are using Solaris/Sparc or MacOS X/PPC, you will need to fix the
+header files:
cd cfrontend/sparc
./fixheaders
@@ -442,7 +496,8 @@ not for the faint of heart, so be forewarned.
Once checked out from the CVS repository, the LLVM suite source code must be
configured via the configure script. This script sets variables in
llvm/Makefile.config and llvm/include/Config/config.h. It
-also populates OBJ_ROOT with the Makefiles needed to build LLVM.
+also populates OBJ_ROOT with the Makefiles needed to begin building
+LLVM.
The following environment variables are used by the configure
script to configure the build system:
@@ -476,7 +531,8 @@ script to configure the build system:
--with-llvmgccdir=LLVMGCCDIR
Path to the location where the LLVM C front end binaries and
- associated libraries will be installed.
+ associated libraries were installed. This must be specified as an
+ absolute pathname.
--enable-optimized
@@ -486,7 +542,8 @@ script to configure the build system:
--enable-jit
- Compile the Just In Time (JIT) functionality. This is not available
+ Compile the Just In Time (JIT) compiler functionality. This is not
+ available
on all platforms. The default is dependent on platform, so it is best
to explicitly enable it if you want it.
@@ -519,10 +576,10 @@ script to configure the build system:
LLVM_LIB_SEARCH_PATH environment variable in your startup scripts.
This environment variable is used to locate "system" libraries like
"-lc" and "-lm" when linking. This variable should be set to
-the absolute path for the bytecode-libs subdirectory of the GCC front end
-install, or LLVMGCCDIR/bytecode-libs. For example, one might set
+the absolute path of the bytecode-libs subdirectory of the GCC front
+end, or LLVMGCCDIR/bytecode-libs. For example, one might set
LLVM_LIB_SEARCH_PATH to
-/home/vadve/lattner/local/x86/llvm-gcc/bytecode-libs for the X86
+/home/vadve/lattner/local/x86/llvm-gcc/bytecode-libs for the x86
version of the GCC front end on our research machines.
--
cgit v1.2.3