X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FGettingStarted.html;h=69510e85be6c434986a7727a03db23219426c323;hb=a75ce9f5d2236d93c117e861e60e6f3f748c9555;hp=9f6ef59b7fda3f08a9fd019012c511a76f9ffba6;hpb=6947e55aff7086d3ad654d4fa1ea9f51f4983424;p=oota-llvm.git diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index 9f6ef59b7fd..69510e85be6 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -17,40 +17,42 @@
  • Getting Started Quickly (A Summary)
  • Requirements
      -
    1. Hardware -
    2. Software -
    3. Broken versions of GCC +
    4. Hardware
      5. +
    5. Software
      6. +
    6. Broken versions of GCC and other tools
  • Getting Started with LLVM
      -
    1. Terminology and Notation -
    2. Setting Up Your Environment -
    3. Unpacking the LLVM Archives -
    4. Checkout LLVM from CVS -
    5. Install the GCC Front End -
    6. Local LLVM Configuration -
    7. Compiling the LLVM Suite Source Code -
    8. The Location of LLVM Object Files -
    9. Optional Configuration Items +
    10. Terminology and Notation
      11. +
    11. Setting Up Your Environment
      12. +
    12. Unpacking the LLVM Archives
      13. +
    13. Checkout LLVM from Subversion
      14. +
    14. Install the GCC Front End
      15. +
    15. Local LLVM Configuration
      16. +
    16. Compiling the LLVM Suite Source Code
      17. +
    17. Cross-Compiling LLVM
      18. +
    18. The Location of LLVM Object Files
      19. +
    19. Optional Configuration Items
  • Program layout
      -
    1. CVS directories -
    2. llvm/examples -
    3. llvm/include -
    4. llvm/lib -
    5. llvm/projects -
    6. llvm/runtime -
    7. llvm/test -
    8. llvm-test -
    9. llvm/tools -
    10. llvm/utils -
    11. llvm/win32 +
    12. llvm/examples
      13. +
    13. llvm/include
      14. +
    14. llvm/lib
      15. +
    15. llvm/projects
      16. +
    16. llvm/runtime
      17. +
    17. llvm/test
      18. +
    18. test-suite
      19. +
    19. llvm/tools
      20. +
    20. llvm/utils
  • An Example Using the LLVM Tool Chain +
      +
    1. Example with llvm-gcc4
      2. +
  • Common Problems
  • Links @@ -77,20 +79,21 @@

    Welcome to LLVM! In order to get started, you first need to know some basic information.

    -

    First, LLVM comes in two pieces. The first piece is the LLVM suite. This -contains all of the tools, libraries, and header files needed to use the low -level virtual machine. It contains an assembler, disassembler, bytecode -analyzer, and bytecode optimizer. It also contains a test suite that can be -used to test the LLVM tools and the GCC front end.

    +

    First, LLVM comes in three pieces. The first piece is the LLVM +suite. This contains all of the tools, libraries, and header files +needed to use the low level virtual machine. It contains an +assembler, disassembler, bitcode analyzer and bitcode optimizer. It +also contains basic regression tests that can be used to test the LLVM +tools and the GCC front end.

    The second piece is the GCC front end. This component provides a version of -GCC that compiles C and C++ code into LLVM bytecode. Currently, the GCC front -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 +GCC that compiles C and C++ code into LLVM bitcode. Currently, the GCC front +end uses the GCC parser to convert code to LLVM. Once +compiled into LLVM bitcode, 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 +There is a third, optional piece called Test Suite. It is a suite of programs with a testing harness that can be used to further test LLVM's functionality and performance.

    @@ -111,19 +114,20 @@ and performance.
  • Read the documentation.
  • Read the documentation.
  • Remember that you were warned twice about reading the documentation.
    • -
  • Install the GCC front end if you intend to compile C or C++: +
  • Install the llvm-gcc-4.2 front end if you intend to compile C or C++ + (see Install the GCC Front End for details):
    1. cd where-you-want-the-C-front-end-to-live
      2. -
    2. gunzip --stdout cfrontend.platform.tar.gz | tar -xvf - -
      3. -
    3. cd cfrontend/platform
      - ./fixheaders
      4. -
    4. Add the cfrontend's "bin" directory to your PATH variable.
      5. +
    5. gunzip --stdout llvm-gcc-4.2-version-platform.tar.gz | tar -xvf -
      6. +
    6. install-binutils-binary-from-MinGW (Windows only)
      7. +
    7. Note: If the binary extension is ".bz" use bunzip2 instead of gunzip.
      8. +
    8. Note: On Windows, use 7-Zip or a similar archiving tool.
      9. +
    9. Add llvm-gcc's "bin" directory to your PATH environment variable.
  • Get the LLVM Source Code