diff --git a/llvm/docs/GettingStarted.html b/llvm/docs/GettingStarted.html index 75731134f5f2..5653fb2a0477 100644 --- a/llvm/docs/GettingStarted.html +++ b/llvm/docs/GettingStarted.html @@ -18,6 +18,7 @@
  1. Hardware
  2. Software +
  3. Broken versions of GCC
  • Getting Started with LLVM @@ -144,9 +145,10 @@ from the LLVM suite.

  • Build the LLVM Suite:
      -
    1. Set your LLVM_LIB_SEARCH_PATH environment variable. -
    2. gmake -k |& tee gnumake.out -    # this is csh or tcsh syntax +
    3. Set your LLVM_LIB_SEARCH_PATH environment variable.
    4. +
    5. gmake -k |& tee gnumake.out +    # this is csh or tcsh syntax
    6. +
    7. If you get an "internal compiler error (ICE)" see below.
    @@ -255,7 +257,7 @@ installed:

    + -

    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 -next section.

    + +
    + Broken versions of GCC +
    -

    The later sections of this guide describe the 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.

    +
    + +

    LLVM is very demanding of the host C++ compiler, and as such tends to expose +bugs in the compiler. In particular, several versions of GCC crash when trying +to compile LLVM. We routinely use GCC 3.3.3 and GCC 3.4.0 and have had success +with them. Other versions of GCC will probably work as well. GCC versions listed +here are known to not work. If you are using one of these versions, please try +to upgrade your GCC to something more recent. If you run into a problem with a +version of GCC not listed here, please let +us know. Please use the "gcc -v" command to find out which version +of GCC you are using. +

    + +

    GCC versions prior to 3.0: GCC 2.96.x and before had several +problems in the STL that effectively prevent it from compiling LLVM. +

    + +

    GCC 3.3.2: This version of GCC suffered from a serious bug which causes it to crash in +the "convert_from_eh_region_ranges_1" GCC function.

    + +
    Getting Started with 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.

    + +

    The later sections of this guide describe the 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.

    +
    +
    Terminology and Notation @@ -671,7 +703,11 @@ builds:

    gmake

    -

    If you have multiple processors in your machine, you may wish to use some of +

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

    + +

    +If you have multiple processors in your machine, you may wish to use some of the parallel build options provided by GNU Make. For example, you could use the command: