diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index bd9624b5512..facc076abd6 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -89,6 +89,12 @@ end is a modified version of GCC 3.4 (we track the GCC 3.4 development). Once compiled into LLVM bytecode, a program can be manipulated with the LLVM tools from the LLVM suite.

+

+There is a third, optional piece called llvm-test. It is a suite of programs +with a testing harness that can be used to further test LLVM's functionality +and performance. +

+ @@ -526,7 +532,7 @@ You can set these on the command line, or better yet, set them in your
alias llvmgcc LLVMGCCDIR/bin/gcc
alias llvmg++ LLVMGCCDIR/bin/g++
- This alias allows you to use the LLVM C and C++ front ends without putting + These aliases allow you to use the LLVM C and C++ front ends without putting them in your PATH or typing in their complete pathnames. @@ -552,7 +558,7 @@ file is a TAR archive that is compressed with the gzip program.
This is the source code for the LLVM libraries and tools.
llvm-test-1.4.tar.gz
-
This is the source code for the LLVM test suite
+
This is the source code for the LLVM test suite.
cfrontend-1.4.source.tar.gz
This is the source release of the GCC front end.
@@ -626,7 +632,7 @@ from the CVS repository:

Please note that you must follow these -instructions to successfully build the LLVM C front-end.

+instructions to successfully build the LLVM GCC front-end.

@@ -725,7 +731,7 @@ script to configure the build system:

Path to the location where the LLVM GCC front end binaries and associated libraries were installed. This must be specified as an absolute pathname. -

+

--with-tclinclude
Path to the tcl include directory under which the tclsh can be @@ -733,13 +739,14 @@ script to configure the build system:

want to use a specific one (8.x) for LLVM. LLVM only uses tcl for running the dejagnu based test suite in llvm/test. If you don't specify this option, the LLVM configure script will search for tcl 8.4 and 8.3 releases. +

--enable-optimized
Enables optimized compilation by default (debugging symbols are removed and GCC optimization flags are enabled). The default is to use an unoptimized build (also known as a debug build). -

+

--enable-jit
@@ -747,7 +754,7 @@ script to configure the build system:

available on all platforms. The default is dependent on platform, so it is best to explicitly enable it if you want it. -

+

--enable-doxygen
Look for the doxygen program and enable construction of doxygen based @@ -824,7 +831,7 @@ builds:

gmake

If the build fails, please check here to see if you -are using a known broken version of GCC to compile LLVM with.

+are using a version of GCC that is known not to compile LLVM.

If you have multiple processors in your machine, you may wish to use some of @@ -852,7 +859,8 @@ source code:

gmake install
- Installs LLVM header files, libraries, tools and documentation in a hierarchy + Installs LLVM header files, libraries, tools, and documentation in a + hierarchy under $PREFIX, specified with ./configure --prefix=[dir], which defaults to /usr/local.

@@ -891,7 +899,7 @@ declaring variables on the command line. The following are some examples:

gmake TOOL_VERBOSE=1
Ask each tool invoked by the makefiles to print out what it is doing on - the standard output. This also implies VERBOSE=1 so the makefile + the standard output. This also implies VERBOSE=1.

@@ -1145,9 +1153,10 @@ end to compile.

llvm-test
-

This is not a directory in the normal llvm module, it is a separate CVS +

This is not a directory in the normal llvm module; it is a separate CVS module that must be checked out (usually to projects/llvm-test). This - module contains a comprehensive correctness, performance and benchmarking test + module contains a comprehensive correctness, performance, and benchmarking + test suite for LLVM. It is a separate CVS module because not every LLVM user is interested in downloading or building such a comprehensive test. For further details on this test suite, please see the @@ -1342,7 +1351,7 @@ are code generators for parts of LLVM infrastructure.

This directory contains build scripts and project files for use with Visual C++. This allows developers on Windows to build LLVM without the need - for cygwin. The contents of this directory should be considered experimental + for Cygwin. The contents of this directory should be considered experimental at this time.