diff --git a/llvm/docs/MakefileGuide.html b/llvm/docs/MakefileGuide.html index af26fa0a1e1e..6a2db5c3252b 100644 --- a/llvm/docs/MakefileGuide.html +++ b/llvm/docs/MakefileGuide.html @@ -30,6 +30,9 @@
  1. Libraries
  2. Tools
  3. +
      +
    1. JIT Tools
    2. +
  • Targets Supported @@ -267,6 +270,41 @@

    + +
    JIT Tools
    +
    +

    Many tools will want to use the JIT features of LLVM. However, getting the + right set of libraries to link with is tedious, platform specific, and error + prone. Additionally, the JIT has special linker switch options that it needs. + Consequently, to make it easier to build tools that use the JIT, you can + use a special value for the LLVMLIBS> variable:

    +
    
    +      TOOLNAME = my_jit_tool
    +      USEDLIBS = mylib
    +      LLVMLIBS = JIT
    +  
    +

    Using a value of JIT for LLVMLIBS tells the makefile + system to construct a special value for LLVMLIBS that gives the program all + the LLVM libraries needed to run the JIT. Any additional libraries needed can + still be specified with USEDLIBS. To get a full understanding of how + this changes the linker command, it is recommended that you:

    +
    
    +      cd examples/Fibonacci
    +      make VERBOSE=1
    +  
    +

    By default, using LLVMLIBS=JIT will link in enough to support JIT + code generation for the architecture on which the tool is linked. If you need + additional target architectures linked in, you may specify them on the command + line or in your Makefile. For example:

    +
    
    +      ENABLE_X86_JIT=1
    +      ENABLE_SPARCV9_JIT=1
    +      ENALBE_PPC_JIT=1
    +  
    +

    will cause the tool to be able to generate code for all three platforms. +

    +
    + @@ -411,9 +449,18 @@

    This target finalizes shared objects and executables and copies all - libraries, headers and executables to the directory given with the - --prefix option to configure. When completed, the prefix - directory will have everything needed to use LLVM.

    + libraries, headers, executables and documentation to the directory given + with the --prefix option to configure. When completed, + the prefix directory will have everything needed to use LLVM.

    +

    The LLVM makefiles can generate complete internal documentation + for all the classes by using doxygen. By default, this feature is + not enabled because it takes a long time and generates a massive + amount of data (>100MB). If you want this feature, you must configure LLVM + with the --enable-doxygen switch and ensure that a modern version of doxygen + (1.3.7 or later) is available in your PATH. You can download + doxygen from + + here.