Members/tobaru/cbc/CbC_llvm: docs/GettingStarted.rst annotate

annotate docs/GettingStarted.rst @ 16:d405342cecb1

can eliminate tail call regardless of optimize level

author	Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp>
date	Tue, 24 Sep 2013 19:04:26 +0900
parents	9ad51c7bc036
children

rev	line source
3 9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1 ====================================
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	2 Getting Started with the LLVM System
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	3 ====================================
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	4
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	5 .. contents::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	6 :local:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	7
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	8 Overview
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	9 ========
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	10
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	11 Welcome to LLVM! In order to get started, you first need to know some basic
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	12 information.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	13
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	14 First, LLVM comes in three pieces. The first piece is the LLVM suite. This
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	15 contains all of the tools, libraries, and header files needed to use LLVM. It
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	16 contains an assembler, disassembler, bitcode analyzer and bitcode optimizer. It
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	17 also contains basic regression tests that can be used to test the LLVM tools and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	18 the Clang front end.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	19
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	20 The second piece is the `Clang <http://clang.llvm.org/>`_ front end. This
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	21 component compiles C, C++, Objective C, and Objective C++ code into LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	22 bitcode. Once compiled into LLVM bitcode, a program can be manipulated with the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	23 LLVM tools from the LLVM suite.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	24
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	25 There is a third, optional piece called Test Suite. It is a suite of programs
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	26 with a testing harness that can be used to further test LLVM's functionality
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	27 and performance.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	28
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	29 Getting Started Quickly (A Summary)
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	30 ===================================
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	31
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	32 The LLVM Getting Started documentation may be out of date. So, the `Clang
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	33 Getting Started <http://clang.llvm.org/get_started.html>`_ page might also be a
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	34 good place to start.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	35
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	36 Here's the short story for getting up and running quickly with LLVM:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	37
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	38 #. Read the documentation.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	39 #. Read the documentation.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	40 #. Remember that you were warned twice about reading the documentation.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	41 #. Checkout LLVM:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	42
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	43 * ``cd where-you-want-llvm-to-live``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	44 * ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	45
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	46 #. Checkout Clang:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	47
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	48 * ``cd where-you-want-llvm-to-live``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	49 * ``cd llvm/tools``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	50 * ``svn co http://llvm.org/svn/llvm-project/cfe/trunk clang``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	51
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	52 #. Checkout Compiler-RT:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	53
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	54 * ``cd where-you-want-llvm-to-live``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	55 * ``cd llvm/projects``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	56 * ``svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	57
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	58 #. Get the Test Suite Source Code [Optional]
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	59
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	60 * ``cd where-you-want-llvm-to-live``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	61 * ``cd llvm/projects``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	62 * ``svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	63
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	64 #. Configure and build LLVM and Clang:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	65
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	66 * ``cd where-you-want-to-build-llvm``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	67 * ``mkdir build`` (for building without polluting the source dir)
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	68 * ``cd build``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	69 * ``../llvm/configure [options]``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	70 Some common options:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	71
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	72 * ``--prefix=directory`` --- Specify for directory the full pathname of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	73 where you want the LLVM tools and libraries to be installed (default
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	74 ``/usr/local``).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	75
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	76 * ``--enable-optimized`` --- Compile with optimizations enabled (default
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	77 is NO).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	78
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	79 * ``--enable-assertions`` --- Compile with assertion checks enabled
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	80 (default is YES).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	81
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	82 * ``make [-j]`` --- The ``-j`` specifies the number of jobs (commands) to run
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	83 simultaneously. This builds both LLVM and Clang for Debug+Asserts mode.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	84 The ``--enabled-optimized`` configure option is used to specify a Release
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	85 build.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	86
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	87 * ``make check-all`` --- This run the regression tests to ensure everything
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	88 is in working order.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	89
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	90 * ``make update`` --- This command is used to update all the svn repositories
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	91 at once, rather then having to ``cd`` into the individual repositories and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	92 running ``svn update``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	93
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	94 * It is also possible to use CMake instead of the makefiles. With CMake it is
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	95 possible to generate project files for several IDEs: Xcode, Eclipse CDT4,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	96 CodeBlocks, Qt-Creator (use the CodeBlocks generator), KDevelop3.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	97
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	98 * If you get an "internal compiler error (ICE)" or test failures, see
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	99 `below`.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	100
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	101 Consult the `Getting Started with LLVM`_ section for detailed information on
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	102 configuring and compiling LLVM. See `Setting Up Your Environment`_ for tips
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	103 that simplify working with the Clang front end and LLVM tools. Go to `Program
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	104 Layout`_ to learn about the layout of the source code tree.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	105
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	106 Requirements
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	107 ============
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	108
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	109 Before you begin to use the LLVM system, review the requirements given below.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	110 This may save you some trouble by knowing ahead of time what hardware and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	111 software you will need.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	112
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	113 Hardware
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	114 --------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	115
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	116 LLVM is known to work on the following platforms:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	117
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	118 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	119 \|OS \| Arch \| Compilers \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	120 +=================+======================+=========================+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	121 \|AuroraUX \| x86\ :sup:`1` \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	122 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	123 \|Linux \| x86\ :sup:`1` \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	124 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	125 \|Linux \| amd64 \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	126 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	127 \|Linux \| ARM\ :sup:`13` \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	128 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	129 \|Solaris \| V9 (Ultrasparc) \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	130 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	131 \|FreeBSD \| x86\ :sup:`1` \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	132 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	133 \|FreeBSD \| amd64 \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	134 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	135 \|MacOS X\ :sup:`2`\| PowerPC \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	136 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	137 \|MacOS X\ :sup:`9`\| x86 \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	138 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	139 \|Cygwin/Win32 \| x86\ :sup:`1, 8, 11` \| GCC 3.4.X, binutils 2.20\|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	140 +-----------------+----------------------+-------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	141
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	142 LLVM has partial support for the following platforms:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	143
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	144 +-------------------+----------------------+-------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	145 \|OS \| Arch \| Compilers \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	146 +===================+======================+===========================================+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	147 \| Windows \| x86\ :sup:`1` \| Visual Studio 2000 or higher\ :sup:`4,5` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	148 +-------------------+----------------------+-------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	149 \| AIX\ :sup:`3,4` \| PowerPC \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	150 +-------------------+----------------------+-------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	151 \| Linux\ :sup:`3,5` \| PowerPC \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	152 +-------------------+----------------------+-------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	153 \| Linux\ :sup:`7` \| Alpha \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	154 +-------------------+----------------------+-------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	155 \| Linux\ :sup:`7` \| Itanium (IA-64) \| GCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	156 +-------------------+----------------------+-------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	157 \| HP-UX\ :sup:`7` \| Itanium (IA-64) \| HP aCC \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	158 +-------------------+----------------------+-------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	159 \| Windows x64 \| x86-64 \| mingw-w64's GCC-4.5.x\ :sup:`12` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	160 +-------------------+----------------------+-------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	161
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	162 .. note::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	163
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	164 #. Code generation supported for Pentium processors and up
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	165 #. Code generation supported for 32-bit ABI only
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	166 #. No native code generation
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	167 #. Build is not complete: one or more tools do not link or function
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	168 #. The GCC-based C/C++ frontend does not build
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	169 #. The port is done using the MSYS shell.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	170 #. Native code generation exists but is not complete.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	171 #. Binutils 2.20 or later is required to build the assembler generated by LLVM properly.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	172 #. Xcode 2.5 and gcc 4.0.1 (Apple Build 5370) will trip internal LLVM assert
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	173 messages when compiled for Release at optimization levels greater than 0
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	174 (i.e., ``-O1`` and higher). Add ``OPTIMIZE_OPTION="-O0"`` to the build
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	175 command line if compiling for LLVM Release or bootstrapping the LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	176 toolchain.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	177 #. For MSYS/MinGW on Windows, be sure to install the MSYS version of the perl
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	178 package, and be sure it appears in your path before any Windows-based
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	179 versions such as Strawberry Perl and ActivePerl, as these have
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	180 Windows-specifics that will cause the build to fail.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	181 #. To use LLVM modules on Win32-based system, you may configure LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	182 with ``--enable-shared``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	183 #. To compile SPU backend, you need to add ``LDFLAGS=-Wl,--stack,16777216`` to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	184 configure.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	185 #. MCJIT not working well pre-v7, old JIT engine not supported any more.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	186
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	187 Note that you will need about 1-3 GB of space for a full LLVM build in Debug
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	188 mode, depending on the system (it is so large because of all the debugging
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	189 information and the fact that the libraries are statically linked into multiple
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	190 tools). If you do not need many of the tools and you are space-conscious, you
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	191 can pass ``ONLY_TOOLS="tools you need"`` to make. The Release build requires
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	192 considerably less space.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	193
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	194 The LLVM suite may compile on other platforms, but it is not guaranteed to do
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	195 so. If compilation is successful, the LLVM utilities should be able to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	196 assemble, disassemble, analyze, and optimize LLVM bitcode. Code generation
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	197 should work as well, although the generated native code may not work on your
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	198 platform.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	199
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	200 Software
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	201 --------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	202
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	203 Compiling LLVM requires that you have several software packages installed. The
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	204 table below lists those required packages. The Package column is the usual name
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	205 for the software package that LLVM depends on. The Version column provides
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	206 "known to work" versions of the package. The Notes column describes how LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	207 uses the package and provides other details.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	208
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	209 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	210 \| Package \| Version \| Notes \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	211 +==============================================================+=================+=============================================+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	212 \| `GNU Make <http://savannah.gnu.org/projects/make>`_ \| 3.79, 3.79.1 \| Makefile/build processor \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	213 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	214 \| `GCC <http://gcc.gnu.org/>`_ \| 3.4.2 \| C/C++ compiler\ :sup:`1` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	215 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	216 \| `TeXinfo <http://www.gnu.org/software/texinfo/>`_ \| 4.5 \| For building the CFE \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	217 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	218 \| `SVN <http://subversion.tigris.org/project_packages.html>`_ \| >=1.3 \| Subversion access to LLVM\ :sup:`2` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	219 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	220 \| `python <http://www.python.org/>`_ \| >=2.4 \| Automated test suite\ :sup:`3` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	221 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	222 \| `perl <http://www.perl.com/download.csp>`_ \| >=5.6.0 \| Utilities \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	223 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	224 \| `GNU M4 <http://savannah.gnu.org/projects/m4>`_ \| 1.4 \| Macro processor for configuration\ :sup:`4` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	225 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	226 \| `GNU Autoconf <http://www.gnu.org/software/autoconf/>`_ \| 2.60 \| Configuration script builder\ :sup:`4` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	227 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	228 \| `GNU Automake <http://www.gnu.org/software/automake/>`_ \| 1.9.6 \| aclocal macro generator\ :sup:`4` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	229 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	230 \| `libtool <http://savannah.gnu.org/projects/libtool>`_ \| 1.5.22 \| Shared library manager\ :sup:`4` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	231 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	232 \| `zlib <http://zlib.net>`_ \| >=1.2.3.4 \| Compression library\ :sup:`5` \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	233 +--------------------------------------------------------------+-----------------+---------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	234
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	235 .. note::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	236
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	237 #. Only the C and C++ languages are needed so there's no need to build the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	238 other languages for LLVM's purposes. See `below` for specific version
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	239 info.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	240 #. You only need Subversion if you intend to build from the latest LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	241 sources. If you're working from a release distribution, you don't need
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	242 Subversion.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	243 #. Only needed if you want to run the automated test suite in the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	244 ``llvm/test`` directory.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	245 #. If you want to make changes to the configure scripts, you will need GNU
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	246 autoconf (2.60), and consequently, GNU M4 (version 1.4 or higher). You
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	247 will also need automake (1.9.6). We only use aclocal from that package.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	248 #. Optional, adds compression/uncompression capabilities to selected LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	249 tools.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	250
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	251 Additionally, your compilation host is expected to have the usual plethora of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	252 Unix utilities. Specifically:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	253
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	254 * ar --- archive library builder
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	255 * bzip2 --- bzip2 command for distribution generation
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	256 * bunzip2 --- bunzip2 command for distribution checking
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	257 * chmod --- change permissions on a file
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	258 * cat --- output concatenation utility
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	259 * cp --- copy files
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	260 * date --- print the current date/time
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	261 * echo --- print to standard output
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	262 * egrep --- extended regular expression search utility
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	263 * find --- find files/dirs in a file system
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	264 * grep --- regular expression search utility
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	265 * gzip --- gzip command for distribution generation
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	266 * gunzip --- gunzip command for distribution checking
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	267 * install --- install directories/files
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	268 * mkdir --- create a directory
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	269 * mv --- move (rename) files
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	270 * ranlib --- symbol table builder for archive libraries
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	271 * rm --- remove (delete) files and directories
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	272 * sed --- stream editor for transforming output
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	273 * sh --- Bourne shell for make build scripts
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	274 * tar --- tape archive for distribution generation
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	275 * test --- test things in file system
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	276 * unzip --- unzip command for distribution checking
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	277 * zip --- zip command for distribution generation
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	278
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	279 .. _below:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	280 .. _check here:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	281
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	282 Broken versions of GCC and other tools
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	283 --------------------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	284
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	285 LLVM is very demanding of the host C++ compiler, and as such tends to expose
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	286 bugs in the compiler. In particular, several versions of GCC crash when trying
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	287 to compile LLVM. We routinely use GCC 4.2 (and higher) or Clang. Other
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	288 versions of GCC will probably work as well. GCC versions listed here are known
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	289 to not work. If you are using one of these versions, please try to upgrade your
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	290 GCC to something more recent. If you run into a problem with a version of GCC
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	291 not listed here, please `let us know <mailto:llvmdev@cs.uiuc.edu>`_. Please use
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	292 the "``gcc -v``" command to find out which version of GCC you are using.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	293
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	294 GCC versions prior to 3.0: GCC 2.96.x and before had several problems in the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	295 STL that effectively prevent it from compiling LLVM.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	296
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	297 GCC 3.2.2 and 3.2.3: These versions of GCC fails to compile LLVM with a
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	298 bogus template error. This was fixed in later GCCs.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	299
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	300 GCC 3.3.2: This version of GCC suffered from a `serious bug
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	301 <http://gcc.gnu.org/PR13392>`_ which causes it to crash in the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	302 "``convert_from_eh_region_ranges_1``" GCC function.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	303
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	304 Cygwin GCC 3.3.3: The version of GCC 3.3.3 commonly shipped with Cygwin does
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	305 not work.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	306
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	307 SuSE GCC 3.3.3: The version of GCC 3.3.3 shipped with SuSE 9.1 (and possibly
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	308 others) does not compile LLVM correctly (it appears that exception handling is
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	309 broken in some cases). Please download the FSF 3.3.3 or upgrade to a newer
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	310 version of GCC.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	311
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	312 GCC 3.4.0 on linux/x86 (32-bit): GCC miscompiles portions of the code
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	313 generator, causing an infinite loop in the llvm-gcc build when built with
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	314 optimizations enabled (i.e. a release build).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	315
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	316 GCC 3.4.2 on linux/x86 (32-bit): GCC miscompiles portions of the code
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	317 generator at -O3, as with 3.4.0. However gcc 3.4.2 (unlike 3.4.0) correctly
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	318 compiles LLVM at -O2. A work around is to build release LLVM builds with
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	319 "``make ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2 ...``"
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	320
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	321 GCC 3.4.x on X86-64/amd64: GCC `miscompiles portions of LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	322 <http://llvm.org/PR1056>`__.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	323
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	324 GCC 3.4.4 (CodeSourcery ARM 2005q3-2): this compiler miscompiles LLVM when
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	325 building with optimizations enabled. It appears to work with "``make
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	326 ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O1``" or build a debug build.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	327
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	328 IA-64 GCC 4.0.0: The IA-64 version of GCC 4.0.0 is known to miscompile LLVM.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	329
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	330 Apple Xcode 2.3: GCC crashes when compiling LLVM at -O3 (which is the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	331 default with ENABLE_OPTIMIZED=1. To work around this, build with
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	332 "``ENABLE_OPTIMIZED=1 OPTIMIZE_OPTION=-O2``".
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	333
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	334 GCC 4.1.1: GCC fails to build LLVM with template concept check errors
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	335 compiling some files. At the time of this writing, GCC mainline (4.2) did not
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	336 share the problem.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	337
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	338 GCC 4.1.1 on X86-64/amd64: GCC `miscompiles portions of LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	339 <http://llvm.org/PR1063>`__ when compiling llvm itself into 64-bit code. LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	340 will appear to mostly work but will be buggy, e.g. failing portions of its
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	341 testsuite.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	342
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	343 GCC 4.1.2 on OpenSUSE: Seg faults during libstdc++ build and on x86_64
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	344 platforms compiling md5.c gets a mangled constant.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	345
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	346 GCC 4.1.2 (20061115 (prerelease) (Debian 4.1.1-21)) on Debian: Appears to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	347 miscompile parts of LLVM 2.4. One symptom is ValueSymbolTable complaining about
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	348 symbols remaining in the table on destruction.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	349
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	350 GCC 4.1.2 20071124 (Red Hat 4.1.2-42): Suffers from the same symptoms as the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	351 previous one. It appears to work with ENABLE_OPTIMIZED=0 (the default).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	352
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	353 Cygwin GCC 4.3.2 20080827 (beta) 2: Users `reported
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	354 <http://llvm.org/PR4145>`_ various problems related with link errors when using
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	355 this GCC version.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	356
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	357 Debian GCC 4.3.2 on X86: Crashes building some files in LLVM 2.6.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	358
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	359 GCC 4.3.3 (Debian 4.3.3-10) on ARM: Miscompiles parts of LLVM 2.6 when
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	360 optimizations are turned on. The symptom is an infinite loop in
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	361 ``FoldingSetImpl::RemoveNode`` while running the code generator.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	362
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	363 SUSE 11 GCC 4.3.4: Miscompiles LLVM, causing crashes in ValueHandle logic.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	364
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	365 GCC 4.3.5 and GCC 4.4.5 on ARM: These can miscompile ``value >> 1`` even at
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	366 ``-O0``. A test failure in ``test/Assembler/alignstack.ll`` is one symptom of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	367 the problem.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	368
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	369 GCC 4.6.3 on ARM: Miscompiles ``llvm-readobj`` at ``-O3``. A test failure
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	370 in ``test/Object/readobj-shared-object.test`` is one symptom of the problem.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	371
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	372 GNU ld 2.16.X. Some 2.16.X versions of the ld linker will produce very long
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	373 warning messages complaining that some "``.gnu.linkonce.t.*``" symbol was
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	374 defined in a discarded section. You can safely ignore these messages as they are
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	375 erroneous and the linkage is correct. These messages disappear using ld 2.17.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	376
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	377 GNU binutils 2.17: Binutils 2.17 contains `a bug
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	378 <http://sourceware.org/bugzilla/show_bug.cgi?id=3111>`__ which causes huge link
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	379 times (minutes instead of seconds) when building LLVM. We recommend upgrading
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	380 to a newer version (2.17.50.0.4 or later).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	381
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	382 GNU Binutils 2.19.1 Gold: This version of Gold contained `a bug
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	383 <http://sourceware.org/bugzilla/show_bug.cgi?id=9836>`__ which causes
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	384 intermittent failures when building LLVM with position independent code. The
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	385 symptom is an error about cyclic dependencies. We recommend upgrading to a
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	386 newer version of Gold.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	387
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	388 Clang 3.0 with libstdc++ 4.7.x: a few Linux distributions (Ubuntu 12.10,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	389 Fedora 17) have both Clang 3.0 and libstdc++ 4.7 in their repositories. Clang
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	390 3.0 does not implement a few builtins that are used in this library. We
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	391 recommend using the system GCC to compile LLVM and Clang in this case.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	392
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	393 Clang 3.0 on Mageia 2. There's a packaging issue: Clang can not find at
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	394 least some (``cxxabi.h``) libstdc++ headers.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	395
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	396 .. _Getting Started with LLVM:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	397
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	398 Getting Started with LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	399 =========================
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	400
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	401 The remainder of this guide is meant to get you up and running with LLVM and to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	402 give you some basic information about the LLVM environment.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	403
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	404 The later sections of this guide describe the `general layout`_ of the LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	405 source tree, a `simple example`_ using the LLVM tool chain, and `links`_ to find
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	406 more information about LLVM or to get help via e-mail.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	407
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	408 Terminology and Notation
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	409 ------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	410
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	411 Throughout this manual, the following names are used to denote paths specific to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	412 the local system and working environment. *These are not environment variables
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	413 you need to set but just strings used in the rest of this document below*. In
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	414 any of the examples below, simply replace each of these names with the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	415 appropriate pathname on your local system. All these paths are absolute:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	416
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	417 ``SRC_ROOT``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	418
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	419 This is the top level directory of the LLVM source tree.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	420
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	421 ``OBJ_ROOT``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	422
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	423 This is the top level directory of the LLVM object tree (i.e. the tree where
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	424 object files and compiled programs will be placed. It can be the same as
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	425 SRC_ROOT).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	426
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	427 .. _Setting Up Your Environment:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	428
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	429 Setting Up Your Environment
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	430 ---------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	431
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	432 In order to compile and use LLVM, you may need to set some environment
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	433 variables.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	434
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	435 ``LLVM_LIB_SEARCH_PATH=/path/to/your/bitcode/libs``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	436
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	437 [Optional] This environment variable helps LLVM linking tools find the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	438 locations of your bitcode libraries. It is provided only as a convenience
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	439 since you can specify the paths using the -L options of the tools and the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	440 C/C++ front-end will automatically use the bitcode files installed in its
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	441 ``lib`` directory.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	442
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	443 Unpacking the LLVM Archives
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	444 ---------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	445
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	446 If you have the LLVM distribution, you will need to unpack it before you can
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	447 begin to compile it. LLVM is distributed as a set of two files: the LLVM suite
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	448 and the LLVM GCC front end compiled for your platform. There is an additional
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	449 test suite that is optional. Each file is a TAR archive that is compressed with
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	450 the gzip program.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	451
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	452 The files are as follows, with x.y marking the version number:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	453
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	454 ``llvm-x.y.tar.gz``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	455
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	456 Source release for the LLVM libraries and tools.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	457
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	458 ``llvm-test-x.y.tar.gz``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	459
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	460 Source release for the LLVM test-suite.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	461
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	462 ``llvm-gcc-4.2-x.y.source.tar.gz``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	463
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	464 Source release of the llvm-gcc-4.2 front end. See README.LLVM in the root
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	465 directory for build instructions.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	466
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	467 ``llvm-gcc-4.2-x.y-platform.tar.gz``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	468
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	469 Binary release of the llvm-gcc-4.2 front end for a specific platform.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	470
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	471 .. _checkout:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	472
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	473 Checkout LLVM from Subversion
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	474 -----------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	475
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	476 If you have access to our Subversion repository, you can get a fresh copy of the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	477 entire source code. All you need to do is check it out from Subversion as
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	478 follows:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	479
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	480 * ``cd where-you-want-llvm-to-live``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	481 * Read-Only: ``svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	482 * Read-Write:``svn co https://user@llvm.org/svn/llvm-project/llvm/trunk llvm``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	483
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	484 This will create an '``llvm``' directory in the current directory and fully
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	485 populate it with the LLVM source code, Makefiles, test directories, and local
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	486 copies of documentation files.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	487
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	488 If you want to get a specific release (as opposed to the most recent revision),
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	489 you can checkout it from the '``tags``' directory (instead of '``trunk``'). The
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	490 following releases are located in the following subdirectories of the '``tags``'
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	491 directory:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	492
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	493 * Release 3.1: RELEASE_31/final
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	494 * Release 3.0: RELEASE_30/final
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	495 * Release 2.9: RELEASE_29/final
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	496 * Release 2.8: RELEASE_28
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	497 * Release 2.7: RELEASE_27
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	498 * Release 2.6: RELEASE_26
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	499 * Release 2.5: RELEASE_25
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	500 * Release 2.4: RELEASE_24
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	501 * Release 2.3: RELEASE_23
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	502 * Release 2.2: RELEASE_22
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	503 * Release 2.1: RELEASE_21
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	504 * Release 2.0: RELEASE_20
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	505 * Release 1.9: RELEASE_19
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	506 * Release 1.8: RELEASE_18
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	507 * Release 1.7: RELEASE_17
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	508 * Release 1.6: RELEASE_16
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	509 * Release 1.5: RELEASE_15
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	510 * Release 1.4: RELEASE_14
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	511 * Release 1.3: RELEASE_13
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	512 * Release 1.2: RELEASE_12
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	513 * Release 1.1: RELEASE_11
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	514 * Release 1.0: RELEASE_1
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	515
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	516 If you would like to get the LLVM test suite (a separate package as of 1.4), you
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	517 get it from the Subversion repository:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	518
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	519 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	520
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	521 % cd llvm/projects
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	522 % svn co http://llvm.org/svn/llvm-project/test-suite/trunk test-suite
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	523
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	524 By placing it in the ``llvm/projects``, it will be automatically configured by
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	525 the LLVM configure script as well as automatically updated when you run ``svn
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	526 update``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	527
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	528 Git Mirror
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	529 ----------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	530
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	531 Git mirrors are available for a number of LLVM subprojects. These mirrors sync
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	532 automatically with each Subversion commit and contain all necessary git-svn
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	533 marks (so, you can recreate git-svn metadata locally). Note that right now
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	534 mirrors reflect only ``trunk`` for each project. You can do the read-only Git
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	535 clone of LLVM via:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	536
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	537 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	538
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	539 % git clone http://llvm.org/git/llvm.git
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	540
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	541 If you want to check out clang too, run:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	542
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	543 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	544
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	545 % cd llvm/tools
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	546 % git clone http://llvm.org/git/clang.git
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	547
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	548 If you want to check out compiler-rt too, run:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	549
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	550 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	551
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	552 % cd llvm/projects
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	553 % git clone http://llvm.org/git/compiler-rt.git
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	554
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	555 If you want to check out the Test Suite Source Code (optional), run:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	556
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	557 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	558
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	559 % cd llvm/projects
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	560 % git clone http://llvm.org/git/test-suite.git
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	561
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	562 Since the upstream repository is in Subversion, you should use ``git
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	563 pull --rebase`` instead of ``git pull`` to avoid generating a non-linear history
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	564 in your clone. To configure ``git pull`` to pass ``--rebase`` by default on the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	565 master branch, run the following command:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	566
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	567 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	568
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	569 % git config branch.master.rebase true
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	570
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	571 Sending patches with Git
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	572 ^^^^^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	573
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	574 Please read `Developer Policy <DeveloperPolicy.html#one-off-patches>`_, too.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	575
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	576 Assume ``master`` points the upstream and ``mybranch`` points your working
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	577 branch, and ``mybranch`` is rebased onto ``master``. At first you may check
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	578 sanity of whitespaces:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	579
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	580 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	581
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	582 % git diff --check master..mybranch
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	583
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	584 The easiest way to generate a patch is as below:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	585
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	586 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	587
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	588 % git diff master..mybranch > /path/to/mybranch.diff
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	589
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	590 It is a little different from svn-generated diff. git-diff-generated diff has
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	591 prefixes like ``a/`` and ``b/``. Don't worry, most developers might know it
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	592 could be accepted with ``patch -p1 -N``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	593
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	594 But you may generate patchset with git-format-patch. It generates by-each-commit
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	595 patchset. To generate patch files to attach to your article:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	596
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	597 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	598
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	599 % git format-patch --no-attach master..mybranch -o /path/to/your/patchset
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	600
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	601 If you would like to send patches directly, you may use git-send-email or
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	602 git-imap-send. Here is an example to generate the patchset in Gmail's [Drafts].
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	603
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	604 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	605
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	606 % git format-patch --attach master..mybranch --stdout \| git imap-send
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	607
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	608 Then, your .git/config should have [imap] sections.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	609
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	610 .. code-block:: ini
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	611
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	612 [imap]
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	613 host = imaps://imap.gmail.com
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	614 user = your.gmail.account@gmail.com
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	615 pass = himitsu!
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	616 port = 993
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	617 sslverify = false
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	618 ; in English
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	619 folder = "[Gmail]/Drafts"
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	620 ; example for Japanese, "Modified UTF-7" encoded.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	621 folder = "[Gmail]/&Tgtm+DBN-"
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	622 ; example for Traditional Chinese
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	623 folder = "[Gmail]/&g0l6Pw-"
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	624
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	625 For developers to work with git-svn
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	626 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	627
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	628 To set up clone from which you can submit code using ``git-svn``, run:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	629
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	630 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	631
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	632 % git clone http://llvm.org/git/llvm.git
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	633 % cd llvm
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	634 % git svn init https://llvm.org/svn/llvm-project/llvm/trunk --username=<username>
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	635 % git config svn-remote.svn.fetch :refs/remotes/origin/master
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	636 % git svn rebase -l # -l avoids fetching ahead of the git mirror.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	637
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	638 # If you have clang too:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	639 % cd tools
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	640 % git clone http://llvm.org/git/clang.git
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	641 % cd clang
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	642 % git svn init https://llvm.org/svn/llvm-project/cfe/trunk --username=<username>
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	643 % git config svn-remote.svn.fetch :refs/remotes/origin/master
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	644 % git svn rebase -l
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	645
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	646 Likewise for compiler-rt and test-suite.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	647
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	648 To update this clone without generating git-svn tags that conflict with the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	649 upstream Git repo, run:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	650
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	651 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	652
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	653 % git fetch && (cd tools/clang && git fetch) # Get matching revisions of both trees.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	654 % git checkout master
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	655 % git svn rebase -l
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	656 % (cd tools/clang &&
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	657 git checkout master &&
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	658 git svn rebase -l)
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	659
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	660 Likewise for compiler-rt and test-suite.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	661
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	662 This leaves your working directories on their master branches, so you'll need to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	663 ``checkout`` each working branch individually and ``rebase`` it on top of its
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	664 parent branch.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	665
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	666 For those who wish to be able to update an llvm repo/revert patches easily using
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	667 git-svn, please look in the directory for the scripts ``git-svnup`` and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	668 ``git-svnrevert``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	669
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	670 To perform the aforementioned update steps go into your source directory and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	671 just type ``git-svnup`` or ``git svnup`` and everything will just work.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	672
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	673 If one wishes to revert a commit with git-svn, but do not want the git hash to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	674 escape into the commit message, one can use the script ``git-svnrevert`` or
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	675 ``git svnrevert`` which will take in the git hash for the commit you want to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	676 revert, look up the appropriate svn revision, and output a message where all
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	677 references to the git hash have been replaced with the svn revision.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	678
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	679 To commit back changes via git-svn, use ``git svn dcommit``:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	680
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	681 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	682
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	683 % git svn dcommit
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	684
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	685 Note that git-svn will create one SVN commit for each Git commit you have pending,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	686 so squash and edit each commit before executing ``dcommit`` to make sure they all
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	687 conform to the coding standards and the developers' policy.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	688
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	689 On success, ``dcommit`` will rebase against the HEAD of SVN, so to avoid conflict,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	690 please make sure your current branch is up-to-date (via fetch/rebase) before
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	691 proceeding.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	692
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	693 The git-svn metadata can get out of sync after you mess around with branches and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	694 ``dcommit``. When that happens, ``git svn dcommit`` stops working, complaining
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	695 about files with uncommitted changes. The fix is to rebuild the metadata:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	696
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	697 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	698
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	699 % rm -rf .git/svn
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	700 % git svn rebase -l
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	701
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	702 Please, refer to the Git-SVN manual (``man git-svn``) for more information.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	703
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	704 Local LLVM Configuration
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	705 ------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	706
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	707 Once checked out from the Subversion repository, the LLVM suite source code must
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	708 be configured via the ``configure`` script. This script sets variables in the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	709 various ``*.in`` files, most notably ``llvm/Makefile.config`` and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	710 ``llvm/include/Config/config.h``. It also populates OBJ_ROOT with the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	711 Makefiles needed to begin building LLVM.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	712
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	713 The following environment variables are used by the ``configure`` script to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	714 configure the build system:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	715
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	716 +------------+-----------------------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	717 \| Variable \| Purpose \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	718 +============+===========================================================+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	719 \| CC \| Tells ``configure`` which C compiler to use. By default, \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	720 \| \| ``configure`` will check ``PATH`` for ``clang`` and GCC C \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	721 \| \| compilers (in this order). Use this variable to override \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	722 \| \| ``configure``\'s default behavior. \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	723 +------------+-----------------------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	724 \| CXX \| Tells ``configure`` which C++ compiler to use. By \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	725 \| \| default, ``configure`` will check ``PATH`` for \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	726 \| \| ``clang++`` and GCC C++ compilers (in this order). Use \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	727 \| \| this variable to override ``configure``'s default \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	728 \| \| behavior. \|
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	729 +------------+-----------------------------------------------------------+
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	730
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	731 The following options can be used to set or enable LLVM specific options:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	732
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	733 ``--enable-optimized``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	734
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	735 Enables optimized compilation (debugging symbols are removed and GCC
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	736 optimization flags are enabled). Note that this is the default setting if you
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	737 are using the LLVM distribution. The default behavior of an Subversion
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	738 checkout is to use an unoptimized build (also known as a debug build).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	739
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	740 ``--enable-debug-runtime``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	741
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	742 Enables debug symbols in the runtime libraries. The default is to strip debug
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	743 symbols from the runtime libraries.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	744
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	745 ``--enable-jit``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	746
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	747 Compile the Just In Time (JIT) compiler functionality. This is not available
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	748 on all platforms. The default is dependent on platform, so it is best to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	749 explicitly enable it if you want it.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	750
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	751 ``--enable-targets=target-option``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	752
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	753 Controls which targets will be built and linked into llc. The default value
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	754 for ``target_options`` is "all" which builds and links all available targets.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	755 The value "host-only" can be specified to build only a native compiler (no
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	756 cross-compiler targets available). The "native" target is selected as the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	757 target of the build host. You can also specify a comma separated list of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	758 target names that you want available in llc. The target names use all lower
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	759 case. The current set of targets is:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	760
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	761 ``arm, cpp, hexagon, mblaze, mips, mipsel, msp430, powerpc, ptx, sparc, spu,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	762 systemz, x86, x86_64, xcore``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	763
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	764 ``--enable-doxygen``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	765
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	766 Look for the doxygen program and enable construction of doxygen based
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	767 documentation from the source code. This is disabled by default because
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	768 generating the documentation can take a long time and producess 100s of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	769 megabytes of output.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	770
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	771 ``--with-udis86``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	772
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	773 LLVM can use external disassembler library for various purposes (now it's used
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	774 only for examining code produced by JIT). This option will enable usage of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	775 `udis86 <http://udis86.sourceforge.net/>`_ x86 (both 32 and 64 bits)
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	776 disassembler library.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	777
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	778 To configure LLVM, follow these steps:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	779
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	780 #. Change directory into the object root directory:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	781
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	782 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	783
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	784 % cd OBJ_ROOT
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	785
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	786 #. Run the ``configure`` script located in the LLVM source tree:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	787
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	788 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	789
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	790 % SRC_ROOT/configure --prefix=/install/path [other options]
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	791
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	792 Compiling the LLVM Suite Source Code
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	793 ------------------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	794
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	795 Once you have configured LLVM, you can build it. There are three types of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	796 builds:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	797
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	798 Debug Builds
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	799
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	800 These builds are the default when one is using an Subversion checkout and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	801 types ``gmake`` (unless the ``--enable-optimized`` option was used during
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	802 configuration). The build system will compile the tools and libraries with
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	803 debugging information. To get a Debug Build using the LLVM distribution the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	804 ``--disable-optimized`` option must be passed to ``configure``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	805
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	806 Release (Optimized) Builds
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	807
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	808 These builds are enabled with the ``--enable-optimized`` option to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	809 ``configure`` or by specifying ``ENABLE_OPTIMIZED=1`` on the ``gmake`` command
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	810 line. For these builds, the build system will compile the tools and libraries
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	811 with GCC optimizations enabled and strip debugging information from the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	812 libraries and executables it generates. Note that Release Builds are default
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	813 when using an LLVM distribution.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	814
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	815 Profile Builds
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	816
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	817 These builds are for use with profiling. They compile profiling information
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	818 into the code for use with programs like ``gprof``. Profile builds must be
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	819 started by specifying ``ENABLE_PROFILING=1`` on the ``gmake`` command line.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	820
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	821 Once you have LLVM configured, you can build it by entering the OBJ_ROOT
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	822 directory and issuing the following command:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	823
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	824 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	825
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	826 % gmake
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	827
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	828 If the build fails, please `check here`_ to see if you are using a version of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	829 GCC that is known not to compile LLVM.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	830
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	831 If you have multiple processors in your machine, you may wish to use some of the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	832 parallel build options provided by GNU Make. For example, you could use the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	833 command:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	834
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	835 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	836
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	837 % gmake -j2
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	838
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	839 There are several special targets which are useful when working with the LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	840 source code:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	841
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	842 ``gmake clean``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	843
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	844 Removes all files generated by the build. This includes object files,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	845 generated C/C++ files, libraries, and executables.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	846
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	847 ``gmake dist-clean``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	848
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	849 Removes everything that ``gmake clean`` does, but also removes files generated
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	850 by ``configure``. It attempts to return the source tree to the original state
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	851 in which it was shipped.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	852
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	853 ``gmake install``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	854
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	855 Installs LLVM header files, libraries, tools, and documentation in a hierarchy
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	856 under ``$PREFIX``, specified with ``./configure --prefix=[dir]``, which
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	857 defaults to ``/usr/local``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	858
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	859 ``gmake -C runtime install-bytecode``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	860
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	861 Assuming you built LLVM into $OBJDIR, when this command is run, it will
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	862 install bitcode libraries into the GCC front end's bitcode library directory.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	863 If you need to update your bitcode libraries, this is the target to use once
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	864 you've built them.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	865
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	866 Please see the `Makefile Guide <MakefileGuide.html>`_ for further details on
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	867 these ``make`` targets and descriptions of other targets available.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	868
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	869 It is also possible to override default values from ``configure`` by declaring
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	870 variables on the command line. The following are some examples:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	871
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	872 ``gmake ENABLE_OPTIMIZED=1``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	873
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	874 Perform a Release (Optimized) build.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	875
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	876 ``gmake ENABLE_OPTIMIZED=1 DISABLE_ASSERTIONS=1``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	877
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	878 Perform a Release (Optimized) build without assertions enabled.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	879
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	880 ``gmake ENABLE_OPTIMIZED=0``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	881
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	882 Perform a Debug build.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	883
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	884 ``gmake ENABLE_PROFILING=1``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	885
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	886 Perform a Profiling build.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	887
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	888 ``gmake VERBOSE=1``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	889
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	890 Print what ``gmake`` is doing on standard output.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	891
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	892 ``gmake TOOL_VERBOSE=1``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	893
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	894 Ask each tool invoked by the makefiles to print out what it is doing on
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	895 the standard output. This also implies ``VERBOSE=1``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	896
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	897 Every directory in the LLVM object tree includes a ``Makefile`` to build it and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	898 any subdirectories that it contains. Entering any directory inside the LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	899 object tree and typing ``gmake`` should rebuild anything in or below that
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	900 directory that is out of date.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	901
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	902 This does not apply to building the documentation.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	903 LLVM's (non-Doxygen) documentation is produced with the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	904 `Sphinx <http://sphinx-doc.org/>`_ documentation generation system.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	905 There are some HTML documents that have not yet been converted to the new
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	906 system (which uses the easy-to-read and easy-to-write
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	907 `reStructuredText <http://sphinx-doc.org/rest.html>`_ plaintext markup
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	908 language).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	909 The generated documentation is built in the ``SRC_ROOT/docs`` directory using
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	910 a special makefile.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	911 For instructions on how to install Sphinx, see
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	912 `Sphinx Introduction for LLVM Developers
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	913 <http://lld.llvm.org/sphinx_intro.html>`_.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	914 After following the instructions there for installing Sphinx, build the LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	915 HTML documentation by doing the following:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	916
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	917 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	918
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	919 $ cd SRC_ROOT/docs
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	920 $ make -f Makefile.sphinx
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	921
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	922 This creates a ``_build/html`` sub-directory with all of the HTML files, not
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	923 just the generated ones.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	924 This directory corresponds to ``llvm.org/docs``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	925 For example, ``_build/html/SphinxQuickstartTemplate.html`` corresponds to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	926 ``llvm.org/docs/SphinxQuickstartTemplate.html``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	927 The :doc:`SphinxQuickstartTemplate` is useful when creating a new document.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	928
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	929 Cross-Compiling LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	930 --------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	931
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	932 It is possible to cross-compile LLVM itself. That is, you can create LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	933 executables and libraries to be hosted on a platform different from the platform
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	934 where they are built (a Canadian Cross build). To configure a cross-compile,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	935 supply the configure script with ``--build`` and ``--host`` options that are
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	936 different. The values of these options must be legal target triples that your
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	937 GCC compiler supports.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	938
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	939 The result of such a build is executables that are not runnable on on the build
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	940 host (--build option) but can be executed on the compile host (--host option).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	941
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	942 The Location of LLVM Object Files
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	943 ---------------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	944
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	945 The LLVM build system is capable of sharing a single LLVM source tree among
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	946 several LLVM builds. Hence, it is possible to build LLVM for several different
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	947 platforms or configurations using the same source tree.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	948
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	949 This is accomplished in the typical autoconf manner:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	950
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	951 * Change directory to where the LLVM object files should live:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	952
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	953 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	954
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	955 % cd OBJ_ROOT
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	956
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	957 * Run the ``configure`` script found in the LLVM source directory:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	958
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	959 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	960
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	961 % SRC_ROOT/configure
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	962
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	963 The LLVM build will place files underneath OBJ_ROOT in directories named after
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	964 the build type:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	965
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	966 Debug Builds with assertions enabled (the default)
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	967
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	968 Tools
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	969
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	970 ``OBJ_ROOT/Debug+Asserts/bin``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	971
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	972 Libraries
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	973
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	974 ``OBJ_ROOT/Debug+Asserts/lib``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	975
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	976 Release Builds
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	977
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	978 Tools
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	979
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	980 ``OBJ_ROOT/Release/bin``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	981
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	982 Libraries
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	983
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	984 ``OBJ_ROOT/Release/lib``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	985
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	986 Profile Builds
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	987
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	988 Tools
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	989
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	990 ``OBJ_ROOT/Profile/bin``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	991
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	992 Libraries
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	993
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	994 ``OBJ_ROOT/Profile/lib``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	995
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	996 Optional Configuration Items
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	997 ----------------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	998
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	999 If you're running on a Linux system that supports the `binfmt_misc
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1000 <http://en.wikipedia.org/wiki/binfmt_misc>`_
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1001 module, and you have root access on the system, you can set your system up to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1002 execute LLVM bitcode files directly. To do this, use commands like this (the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1003 first command may not be required if you are already using the module):
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1004
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1005 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1006
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1007 % mount -t binfmt_misc none /proc/sys/fs/binfmt_misc
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1008 % echo ':llvm:M::BC::/path/to/lli:' > /proc/sys/fs/binfmt_misc/register
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1009 % chmod u+x hello.bc (if needed)
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1010 % ./hello.bc
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1011
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1012 This allows you to execute LLVM bitcode files directly. On Debian, you can also
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1013 use this command instead of the 'echo' command above:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1014
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1015 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1016
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1017 % sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1018
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1019 .. _Program Layout:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1020 .. _general layout:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1021
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1022 Program Layout
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1023 ==============
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1024
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1025 One useful source of information about the LLVM source base is the LLVM `doxygen
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1026 <http://www.doxygen.org/>`_ documentation available at
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1027 `<http://llvm.org/doxygen/>`_. The following is a brief introduction to code
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1028 layout:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1029
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1030 ``llvm/examples``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1031 -----------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1032
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1033 This directory contains some simple examples of how to use the LLVM IR and JIT.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1034
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1035 ``llvm/include``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1036 ----------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1037
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1038 This directory contains public header files exported from the LLVM library. The
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1039 three main subdirectories of this directory are:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1040
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1041 ``llvm/include/llvm``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1042
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1043 This directory contains all of the LLVM specific header files. This directory
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1044 also has subdirectories for different portions of LLVM: ``Analysis``,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1045 ``CodeGen``, ``Target``, ``Transforms``, etc...
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1046
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1047 ``llvm/include/llvm/Support``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1048
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1049 This directory contains generic support libraries that are provided with LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1050 but not necessarily specific to LLVM. For example, some C++ STL utilities and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1051 a Command Line option processing library store their header files here.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1052
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1053 ``llvm/include/llvm/Config``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1054
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1055 This directory contains header files configured by the ``configure`` script.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1056 They wrap "standard" UNIX and C header files. Source code can include these
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1057 header files which automatically take care of the conditional #includes that
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1058 the ``configure`` script generates.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1059
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1060 ``llvm/lib``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1061 ------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1062
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1063 This directory contains most of the source files of the LLVM system. In LLVM,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1064 almost all code exists in libraries, making it very easy to share code among the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1065 different `tools`_.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1066
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1067 ``llvm/lib/VMCore/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1068
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1069 This directory holds the core LLVM source files that implement core classes
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1070 like Instruction and BasicBlock.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1071
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1072 ``llvm/lib/AsmParser/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1073
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1074 This directory holds the source code for the LLVM assembly language parser
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1075 library.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1076
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1077 ``llvm/lib/BitCode/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1078
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1079 This directory holds code for reading and write LLVM bitcode.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1080
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1081 ``llvm/lib/Analysis/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1082
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1083 This directory contains a variety of different program analyses, such as
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1084 Dominator Information, Call Graphs, Induction Variables, Interval
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1085 Identification, Natural Loop Identification, etc.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1086
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1087 ``llvm/lib/Transforms/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1088
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1089 This directory contains the source code for the LLVM to LLVM program
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1090 transformations, such as Aggressive Dead Code Elimination, Sparse Conditional
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1091 Constant Propagation, Inlining, Loop Invariant Code Motion, Dead Global
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1092 Elimination, and many others.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1093
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1094 ``llvm/lib/Target/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1095
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1096 This directory contains files that describe various target architectures for
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1097 code generation. For example, the ``llvm/lib/Target/X86`` directory holds the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1098 X86 machine description while ``llvm/lib/Target/ARM`` implements the ARM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1099 backend.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1100
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1101 ``llvm/lib/CodeGen/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1102
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1103 This directory contains the major parts of the code generator: Instruction
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1104 Selector, Instruction Scheduling, and Register Allocation.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1105
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1106 ``llvm/lib/MC/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1107
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1108 (FIXME: T.B.D.)
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1109
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1110 ``llvm/lib/Debugger/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1111
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1112 This directory contains the source level debugger library that makes it
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1113 possible to instrument LLVM programs so that a debugger could identify source
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1114 code locations at which the program is executing.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1115
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1116 ``llvm/lib/ExecutionEngine/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1117
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1118 This directory contains libraries for executing LLVM bitcode directly at
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1119 runtime in both interpreted and JIT compiled fashions.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1120
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1121 ``llvm/lib/Support/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1122
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1123 This directory contains the source code that corresponds to the header files
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1124 located in ``llvm/include/ADT/`` and ``llvm/include/Support/``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1125
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1126 ``llvm/projects``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1127 -----------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1128
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1129 This directory contains projects that are not strictly part of LLVM but are
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1130 shipped with LLVM. This is also the directory where you should create your own
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1131 LLVM-based projects. See ``llvm/projects/sample`` for an example of how to set
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1132 up your own project.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1133
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1134 ``llvm/runtime``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1135 ----------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1136
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1137 This directory contains libraries which are compiled into LLVM bitcode and used
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1138 when linking programs with the Clang front end. Most of these libraries are
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1139 skeleton versions of real libraries; for example, libc is a stripped down
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1140 version of glibc.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1141
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1142 Unlike the rest of the LLVM suite, this directory needs the LLVM GCC front end
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1143 to compile.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1144
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1145 ``llvm/test``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1146 -------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1147
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1148 This directory contains feature and regression tests and other basic sanity
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1149 checks on the LLVM infrastructure. These are intended to run quickly and cover a
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1150 lot of territory without being exhaustive.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1151
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1152 ``test-suite``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1153 --------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1154
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1155 This is not a directory in the normal llvm module; it is a separate Subversion
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1156 module that must be checked out (usually to ``projects/test-suite``). This
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1157 module contains a comprehensive correctness, performance, and benchmarking test
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1158 suite for LLVM. It is a separate Subversion module because not every LLVM user
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1159 is interested in downloading or building such a comprehensive test suite. For
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1160 further details on this test suite, please see the :doc:`Testing Guide
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1161 <TestingGuide>` document.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1162
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1163 .. _tools:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1164
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1165 ``llvm/tools``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1166 --------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1167
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1168 The tools directory contains the executables built out of the libraries
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1169 above, which form the main part of the user interface. You can always get help
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1170 for a tool by typing ``tool_name -help``. The following is a brief introduction
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1171 to the most important tools. More detailed information is in
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1172 the `Command Guide <CommandGuide/index.html>`_.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1173
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1174 ``bugpoint``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1175
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1176 ``bugpoint`` is used to debug optimization passes or code generation backends
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1177 by narrowing down the given test case to the minimum number of passes and/or
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1178 instructions that still cause a problem, whether it is a crash or
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1179 miscompilation. See `<HowToSubmitABug.html>`_ for more information on using
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1180 ``bugpoint``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1181
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1182 ``llvm-ar``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1183
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1184 The archiver produces an archive containing the given LLVM bitcode files,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1185 optionally with an index for faster lookup.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1186
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1187 ``llvm-as``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1188
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1189 The assembler transforms the human readable LLVM assembly to LLVM bitcode.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1190
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1191 ``llvm-dis``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1192
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1193 The disassembler transforms the LLVM bitcode to human readable LLVM assembly.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1194
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1195 ``llvm-link``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1196
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1197 ``llvm-link``, not surprisingly, links multiple LLVM modules into a single
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1198 program.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1199
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1200 ``lli``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1201
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1202 ``lli`` is the LLVM interpreter, which can directly execute LLVM bitcode
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1203 (although very slowly...). For architectures that support it (currently x86,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1204 Sparc, and PowerPC), by default, ``lli`` will function as a Just-In-Time
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1205 compiler (if the functionality was compiled in), and will execute the code
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1206 much faster than the interpreter.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1207
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1208 ``llc``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1209
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1210 ``llc`` is the LLVM backend compiler, which translates LLVM bitcode to a
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1211 native code assembly file or to C code (with the ``-march=c`` option).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1212
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1213 ``opt``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1214
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1215 ``opt`` reads LLVM bitcode, applies a series of LLVM to LLVM transformations
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1216 (which are specified on the command line), and then outputs the resultant
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1217 bitcode. The '``opt -help``' command is a good way to get a list of the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1218 program transformations available in LLVM.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1219
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1220 ``opt`` can also be used to run a specific analysis on an input LLVM bitcode
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1221 file and print out the results. It is primarily useful for debugging
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1222 analyses, or familiarizing yourself with what an analysis does.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1223
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1224 ``llvm/utils``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1225 --------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1226
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1227 This directory contains utilities for working with LLVM source code, and some of
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1228 the utilities are actually required as part of the build process because they
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1229 are code generators for parts of LLVM infrastructure.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1230
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1231
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1232 ``codegen-diff``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1233
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1234 ``codegen-diff`` is a script that finds differences between code that LLC
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1235 generates and code that LLI generates. This is a useful tool if you are
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1236 debugging one of them, assuming that the other generates correct output. For
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1237 the full user manual, run ```perldoc codegen-diff'``.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1238
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1239 ``emacs/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1240
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1241 The ``emacs`` directory contains syntax-highlighting files which will work
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1242 with Emacs and XEmacs editors, providing syntax highlighting support for LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1243 assembly files and TableGen description files. For information on how to use
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1244 the syntax files, consult the ``README`` file in that directory.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1245
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1246 ``getsrcs.sh``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1247
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1248 The ``getsrcs.sh`` script finds and outputs all non-generated source files,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1249 which is useful if one wishes to do a lot of development across directories
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1250 and does not want to individually find each file. One way to use it is to run,
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1251 for example: ``xemacs `utils/getsources.sh``` from the top of your LLVM source
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1252 tree.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1253
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1254 ``llvmgrep``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1255
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1256 This little tool performs an ``egrep -H -n`` on each source file in LLVM and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1257 passes to it a regular expression provided on ``llvmgrep``'s command
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1258 line. This is a very efficient way of searching the source base for a
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1259 particular regular expression.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1260
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1261 ``makellvm``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1262
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1263 The ``makellvm`` script compiles all files in the current directory and then
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1264 compiles and links the tool that is the first argument. For example, assuming
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1265 you are in the directory ``llvm/lib/Target/Sparc``, if ``makellvm`` is in your
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1266 path, simply running ``makellvm llc`` will make a build of the current
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1267 directory, switch to directory ``llvm/tools/llc`` and build it, causing a
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1268 re-linking of LLC.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1269
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1270 ``TableGen/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1271
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1272 The ``TableGen`` directory contains the tool used to generate register
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1273 descriptions, instruction set descriptions, and even assemblers from common
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1274 TableGen description files.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1275
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1276 ``vim/``
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1277
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1278 The ``vim`` directory contains syntax-highlighting files which will work with
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1279 the VIM editor, providing syntax highlighting support for LLVM assembly files
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1280 and TableGen description files. For information on how to use the syntax
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1281 files, consult the ``README`` file in that directory.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1282
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1283 .. _simple example:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1284
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1285 An Example Using the LLVM Tool Chain
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1286 ====================================
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1287
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1288 This section gives an example of using LLVM with the Clang front end.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1289
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1290 Example with clang
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1291 ------------------
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1292
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1293 #. First, create a simple C file, name it 'hello.c':
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1294
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1295 .. code-block:: c
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1296
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1297 #include <stdio.h>
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1298
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1299 int main() {
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1300 printf("hello world\n");
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1301 return 0;
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1302 }
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1303
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1304 #. Next, compile the C file into a native executable:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1305
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1306 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1307
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1308 % clang hello.c -o hello
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1309
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1310 .. note::
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1311
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1312 Clang works just like GCC by default. The standard -S and -c arguments
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1313 work as usual (producing a native .s or .o file, respectively).
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1314
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1315 #. Next, compile the C file into a LLVM bitcode file:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1316
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1317 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1318
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1319 % clang -O3 -emit-llvm hello.c -c -o hello.bc
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1320
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1321 The -emit-llvm option can be used with the -S or -c options to emit an LLVM
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1322 ``.ll`` or ``.bc`` file (respectively) for the code. This allows you to use
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1323 the `standard LLVM tools <CommandGuide/index.html>`_ on the bitcode file.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1324
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1325 #. Run the program in both forms. To run the program, use:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1326
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1327 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1328
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1329 % ./hello
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1330
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1331 and
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1332
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1333 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1334
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1335 % lli hello.bc
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1336
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1337 The second examples shows how to invoke the LLVM JIT, :doc:`lli
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1338 <CommandGuide/lli>`.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1339
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1340 #. Use the ``llvm-dis`` utility to take a look at the LLVM assembly code:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1341
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1342 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1343
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1344 % llvm-dis < hello.bc \| less
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1345
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1346 #. Compile the program to native assembly using the LLC code generator:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1347
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1348 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1349
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1350 % llc hello.bc -o hello.s
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1351
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1352 #. Assemble the native assembly language file into a program:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1353
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1354 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1355
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1356 % /opt/SUNWspro/bin/cc -xarch=v9 hello.s -o hello.native # On Solaris
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1357
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1358 % gcc hello.s -o hello.native # On others
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1359
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1360 #. Execute the native code program:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1361
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1362 .. code-block:: console
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1363
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1364 % ./hello.native
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1365
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1366 Note that using clang to compile directly to native code (i.e. when the
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1367 ``-emit-llvm`` option is not present) does steps 6/7/8 for you.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1368
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1369 Common Problems
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1370 ===============
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1371
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1372 If you are having problems building or using LLVM, or if you have any other
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1373 general questions about LLVM, please consult the `Frequently Asked
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1374 Questions <FAQ.html>`_ page.
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1375
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1376 .. _links:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1377
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1378 Links
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1379 =====
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1380
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1381 This document is just an introduction on how to use LLVM to do some simple
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1382 things... there are many more interesting and complicated things that you can do
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1383 that aren't documented here (but we'll gladly accept a patch if you want to
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1384 write something up!). For more information about LLVM, check out:
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1385
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1386 * `LLVM Homepage <http://llvm.org/>`_
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1387 * `LLVM Doxygen Tree <http://llvm.org/doxygen/>`_
9ad51c7bc036 1st commit. remove git dir and add all files. Kaito Tokumori <e105711@ie.u-ryukyu.ac.jp> parents: diff changeset	1388 * `Starting a Project that Uses LLVM <http://llvm.org/docs/Projects.html>`_

Mercurial > hg > Members > tobaru > cbc > CbC_llvm

annotate docs/GettingStarted.rst @ 16:d405342cecb1