From 9abd8af71e1516346f43c8e9978b7dba1fa0e939 Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Thu, 7 Sep 2006 04:19:09 +0000 Subject: [PATCH] cleanups and updates to the GSG, patch by B Scott Michel, thanks! This is PR899 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@30143 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/GettingStarted.html | 93 ++++++++++++++++++++++------------------ 1 file changed, 52 insertions(+), 41 deletions(-) diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index 085bc460b49..dad79fdc40d 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -52,6 +52,10 @@
  • An Example Using the LLVM Tool Chain +
      +
    1. Example with llvm-gcc4
      2. +
    2. Example with llvm-gcc3
      3. +
  • Common Problems
  • Links @@ -206,7 +210,7 @@ software you will need.

    LLVM is known to work on the following platforms:

    - +
    @@ -257,7 +261,7 @@ software you will need.

    LLVM has partial support for the following platforms:

    -
    OS Arch
    +
    @@ -347,7 +351,7 @@ href="CFEBuildInstrs.html">try to compile it on your platform.

    is the usual name for the software package that LLVM depends on. The Version column provides "known to work" versions of the package. The Notes column describes how LLVM uses the package and provides other details.

    -
    OS Arch
    +
    @@ -439,7 +443,7 @@ href="CFEBuildInstrs.html">try to compile it on your platform.

    Notes:

      -
    1. Only the C and C++ languages are needed so there's no +
    2. Only the C and C++ languages are needed so there's no need to build the other languages for LLVM's purposes. See below for specific version info.
    3. You only need CVS if you intend to build from the @@ -566,14 +570,14 @@ All these paths are absolute:

      SRC_ROOT
      This is the top level directory of the LLVM source tree. -

      +

      OBJ_ROOT
      This is the top level directory of the LLVM object tree (i.e. the tree where object files and compiled programs will be placed. It can be the same as SRC_ROOT). -

      +

      LLVMGCCDIR
      @@ -765,7 +769,7 @@ the Makefiles needed to begin building LLVM.

      The following environment variables are used by the configure script to configure the build system:

      -
    PackageVersionNotes
    +
    @@ -807,14 +811,14 @@ script to configure the build system:

    dejagnu based test suite in llvm/test. If you don't specify this option, the LLVM configure script will search for the 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-debug-runtime
    @@ -827,7 +831,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-targets=target-option
    Controls which targets will be built and linked into llc. The default @@ -838,7 +842,7 @@ script to configure the build system:

    separated list of target names that you want available in llc. The target names use all lower case. The current set of targets is:
    alpha, ia64, powerpc, skeleton, sparc, x86. -

    +

    --enable-doxygen
    Look for the doxygen program and enable construction of doxygen based documentation from the source code. This is disabled by default because @@ -852,12 +856,12 @@ script to configure the build system:

  • Change directory into the object root directory:
    cd OBJ_ROOT -

    +

  • Run the configure script located in the LLVM source tree:
    SRC_ROOT/configure --prefix=/install/path [other options] -

    +

    @@ -879,7 +883,7 @@ builds:

    --enable-optimized option was used during configuration). The build system will compile the tools and libraries with debugging information. -

    +

    Release (Optimized) Builds
    @@ -888,7 +892,7 @@ builds:

    gmake command line. For these builds, the build system will compile the tools and libraries with GCC optimizations enabled and strip debugging information from the libraries and executables it generates. -

    +

    Profile Builds
    @@ -921,14 +925,14 @@ source code:

    Removes all files generated by the build. This includes object files, generated C/C++ files, libraries, and executables. -

    +

    gmake dist-clean
    Removes everything that gmake clean does, but also removes files generated by configure. It attempts to return the source tree to the original state in which it was shipped. -

    +

    gmake install
    @@ -936,15 +940,15 @@ source code:

    hierarchy under $PREFIX, specified with ./configure --prefix=[dir], which defaults to /usr/local. -

    - +

    +

    gmake -C runtime install-bytecode
    Assuming you built LLVM into $OBJDIR, when this command is run, it will install bytecode libraries into the GCC front end's bytecode library directory. If you need to update your bytecode libraries, this is the target to use once you've built them. -

    +

    Please see the Makefile Guide for further @@ -958,27 +962,27 @@ declaring variables on the command line. The following are some examples:

    gmake ENABLE_OPTIMIZED=1
    Perform a Release (Optimized) build. -

    +

    gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1
    Perform a Release (Optimized) build without assertions enabled. -

    +

    gmake ENABLE_PROFILING=1
    Perform a Profiling build. -

    +

    gmake VERBOSE=1
    Print what gmake is doing on standard output. -

    +

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

    +

    • Every directory in the LLVM object tree includes a Makefile to build @@ -1069,7 +1073,7 @@ named after the build type:

    Libraries
    OBJ_ROOT/Debug/lib -

    +

    Release Builds
    @@ -1079,7 +1083,7 @@ named after the build type:

    Libraries
    OBJ_ROOT/Release/lib -

    +

    Profile Builds
    @@ -1413,7 +1417,7 @@ are code generators for parts of LLVM infrastructure.

    that finds differences between code that LLC generates and code that LLI generates. This is a useful tool if you are debugging one of them, assuming that the other generates correct output. For the full user - manual, run `perldoc codegen-diff'.

    + manual, run `perldoc codegen-diff'.

    cvsupdate
    cvsupdate is a script that will update your CVS tree, but produce a much cleaner and more organized output @@ -1421,21 +1425,21 @@ are code generators for parts of LLVM infrastructure.

    together all the new and updated files and modified files in separate sections, so you can see at a glance what has changed. If you are at the top of your LLVM CVS tree, running utils/cvsupdate is the - preferred way of updating the tree.

    + preferred way of updating the tree.

    emacs/
    The emacs directory contains syntax-highlighting files which will work with Emacs and XEmacs editors, providing syntax highlighting support for LLVM assembly files and TableGen description files. For information on how to use the syntax files, consult - the README file in that directory.

    + the README file in that directory.

    getsrcs.sh
    The getsrcs.sh script finds and outputs all non-generated source files, which is useful if one wishes to do a lot of development across directories and does not want to individually find each file. One way to use it is to run, for example: xemacs `utils/getsources.sh` from the top of your LLVM source - tree.

    - + tree.

    +

    llvmgrep
    This little tool performs an "egrep -H -n" on each source file in LLVM and passes to it a regular expression provided on llvmgrep's command @@ -1448,24 +1452,24 @@ are code generators for parts of LLVM infrastructure.

    llvm/lib/Target/Sparc, if makellvm is in your path, simply running makellvm llc will make a build of the current directory, switch to directory llvm/tools/llc and build it, - causing a re-linking of LLC.

    + causing a re-linking of LLC.

    NightlyTest.pl and NightlyTestTemplate.html
    These files are used in a cron script to generate nightly status reports of the functionality of tools, and the results can be seen by following the appropriate link on - the LLVM homepage.

    + the LLVM homepage.

    TableGen/
    The TableGen directory contains the tool used to generate register descriptions, instruction set descriptions, and even assemblers from common TableGen description - files.

    + files.

    vim/
    The vim directory contains syntax-highlighting files which will work with the VIM editor, providing syntax highlighting support for LLVM assembly files and TableGen description files. For information on how to use the syntax files, consult - the README file in that directory.

    + the README file in that directory.

    @@ -1490,10 +1494,17 @@ are code generators for parts of LLVM infrastructure.

    This section gives an example of using LLVM. Since we are currently transitioning from llvm-gcc3 to llvm-gcc4, we include examples for both.

    + +

    Note: The gcc4 frontend's invocation is considerably different +from the previous gcc3 frontend. In particular, the gcc4 frontend does not +create bytecode by default: gcc4 produces native code. As the example below illustrates, +the '--emit-llvm' flag is needed to produce LLVM bytecode output. For makefiles and +configure scripts, the CFLAGS variable needs '--emit-llvm' to produce bytecode +output.

    -
    Example with llvm-gcc4
    +
    Example with llvm-gcc4
    @@ -1540,7 +1551,7 @@ transitioning from llvm-gcc3 to llvm-gcc4, we include examples for both.

  • Use the llvm-dis utility to take a look at the LLVM assembly code:

    -

    % llvm-dis < hello.bc | less

    • +

    % llvm-dis < hello.bc | less

  • Compile the program to native assembly using the LLC code generator:

    @@ -1595,9 +1606,9 @@ transitioning from llvm-gcc3 to llvm-gcc4, we include examples for both.

  • Run the program. To make sure the program ran, execute one of the following commands:

    - +

    % ./hello

    - +

    or

    % lli hello.bc

    • @@ -1605,7 +1616,7 @@ transitioning from llvm-gcc3 to llvm-gcc4, we include examples for both.

  • Use the llvm-dis utility to take a look at the LLVM assembly code:

    -

    % llvm-dis < hello.bc | less

    • +

    % llvm-dis < hello.bc | less

  • Compile the program to native assembly using the LLC code generator:

    -- 2.34.1
    • VariablePurpose
    CC