Home | History | Annotate | Download | only in mclinker
      1 ------------------------------------------------------------------------------
      2                             MCLinker Project
      3 ------------------------------------------------------------------------------
      4 ============
      5 Introduction
      6 ============
      7   MCLinker is a linkage editor.
      8 
      9 ========================
     10 Compilation Instructions
     11 ========================
     12   The simplest way to compile this package is:
     13 
     14 ----------------------
     15 Prepare LLVM and Clang
     16 ----------------------
     17   0.a Download LLVM 3.1@r155090
     18       `svn co -r 155090 http://llvm.org/svn/llvm-project/llvm/trunk llvm-src'
     19 
     20   0.b Type `cd llvm-src' to enter the directory containing LLVM source code
     21 
     22   0.c Apply patches from MCLinker
     23       `patch -p0 < ${MCLinker}/patch/LLVM.patch'
     24 
     25   0.d Download Clang @r155088
     26       `cd tools'
     27       `svn co -r 155088 http://llvm.org/svn/llvm-project/cfe/trunk clang'
     28 
     29   0.e Build and install LLVM
     30       `cd ../../'
     31       `mkdir llvm-build && cd ./llvm-build'
     32       `../llvm/configure --prefix=${LLVM_INSTALL}'
     33       `make all install'
     34 
     35 --------------
     36 Build MCLinker
     37 --------------
     38 
     39   1.  Type `cd ${MCLinker}' to the directory containing the source code.
     40 
     41   2.  source ./scripts/envsetup.sh
     42 
     43   3.  If there are no `configure' shell script in the directory, type
     44       `./autogen.sh' to generate `configure' script.
     45 
     46   4.  Type `./configure` to configure the package for your system. See INSTALL
     47       for more details.
     48 
     49   5.  Type `make` to compile the package
     50 
     51   6.  Type `make install` to install the package into your system.
     52 
     53 ===================
     54 Directory Structure
     55 ===================
     56 README               - this document
     57 Makefile.am          - input of automake
     58 configure.ac         - input of autoconf
     59 src/                 - source code of verification tool
     60 include/             - include file, exported interface
     61 lib/                 - source code of exported interface
     62 debug/               - placeholder of object files which are compiled for debugging
     63 optimized/           - placeholder of object files which are compiled for optimization
     64 test/                - placeholder of testcases
     65