From 18df1d4eb400581dcb504975473efb7cbba1ead4 Mon Sep 17 00:00:00 2001 From: Jim Grosbach Date: Thu, 17 Dec 2009 17:18:11 +0000 Subject: [PATCH] Add more detail for getting started on Windows. Patch from jon.forums at gmail.com git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@91603 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/GettingStarted.html | 77 ++++++++++++++++++++++++++++------------ 1 file changed, 54 insertions(+), 23 deletions(-) diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index 6dd32a8d7d5..c27101e27b7 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -114,13 +114,15 @@ and performance.
  • Read the documentation.
  • Read the documentation.
  • Remember that you were warned twice about reading the documentation.
    • -
  • Install the llvm-gcc-4.2 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 llvm-gcc-4.2-version-platform.tar.gz | tar -xvf - -
      3. -
    3. Note: If the binary extension is ".bz" use bunzip2 instead of gunzip.
      4. -
    4. Add llvm-gcc'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 @@ -774,13 +776,14 @@ instructions to successfully get and build the LLVM GCC front-end.

    -

    Before configuring and compiling the LLVM suite, you can optionally extract the -LLVM GCC front end from the binary distribution. It is used for running the -llvm-test testsuite and for compiling C/C++ programs. Note that you can optionally -build llvm-gcc yourself after building the +

    Before configuring and compiling the LLVM suite (or if you want to use just the LLVM +GCC front end) you can optionally extract the front end from the binary distribution. +It is used for running the llvm-test testsuite and for compiling C/C++ programs. Note that +you can optionally build llvm-gcc yourself after building the main LLVM repository.

    -

    To install the GCC front end, do the following:

    +

    To install the GCC front end, do the following (on Windows, use an archival tool +like 7-zip that understands gzipped tars):

    1. cd where-you-want-the-front-end-to-live
      2. @@ -788,22 +791,51 @@ main LLVM repository.

      -
    -

    Once the binary is uncompressed, you should add a symlink for llvm-gcc and -llvm-g++ to some directory in your path. When you configure LLVM, it will -automatically detect llvm-gcc's presence (if it is in your path) enabling its -use in llvm-test. Note that you can always build or install llvm-gcc at any -pointer after building the main LLVM repository: just reconfigure llvm and +

    Once the binary is uncompressed, if you're using a *nix-based system, add a symlink for +llvm-gcc and llvm-g++ to some directory in your path. If you're using a +Windows-based system, add the bin subdirectory of your front end installation directory +to your PATH environment variable. For example, if you uncompressed the binary to +c:\llvm-gcc, add c:\llvm-gcc\bin to your PATH.

    + +

    If you now want to build LLVM from source, when you configure LLVM, it will +automatically detect llvm-gcc's presence (if it is in your path) enabling its +use in llvm-test. Note that you can always build or install llvm-gcc at any +point after building the main LLVM repository: just reconfigure llvm and llvm-test will pick it up.

    -

    The binary versions of the GCC front end may not suit all of your needs. For -example, the binary distribution may include an old version of a system header -file, not "fix" a header file that needs to be fixed for GCC, or it may be -linked with libraries not available on your system.

    +

    As a convenience for Windows users, the front end binaries for MinGW/x86 include +versions of the required w32api and mingw-runtime binaries. The last remaining step for +Windows users is to simply uncompress the binary binutils package from +MinGW into your front end installation directory. While the +front end installation steps are not quite the same as a typical manual MinGW installation, +they should be similar enough to those who have previously installed MinGW on Windows systems.

    + +

    To install binutils on Windows:

    + +
      +
    1. download GNU Binutils from MinGW Downloads
      2. +
    2. cd where-you-uncompressed-the-front-end
      3. +
    3. uncompress archived binutils directories (not the tar file) into the current directory
      4. +
    -

    In cases like these, you may want to try building the GCC front end from source. This is -much easier now than it was in the past.

    +

    The binary versions of the LLVM GCC front end may not suit all of your needs. For +example, the binary distribution may include an old version of a system header +file, not "fix" a header file that needs to be fixed for GCC, or it may be linked with +libraries not available on your system. In cases like these, you may want to try +building the GCC front end from source. Thankfully, +this is much easier now than it was in the past.

    + +

    We also do not currently support updating of the GCC front end by manually overlaying +newer versions of the w32api and mingw-runtime binary packages that may become available +from MinGW. At this time, it's best to think of the MinGW LLVM GCC front end binary as +a self-contained convenience package that requires Windows users to simply download and +uncompress the GNU Binutils binary package from the MinGW project.

    + +

    Regardless of your platform, if you discover that installing the LLVM GCC front end +binaries is not as easy as previously described, or you would like to suggest improvements, +please let us know how you would like to see things improved by dropping us a note on our +mailing list.

    @@ -1171,7 +1203,6 @@ Cummings for pointing this out! -
    Program Layout -- 2.34.1