Add bitcode instruction encoding documentation for module version
[oota-llvm.git] / docs / HowToBuildOnARM.rst
1 .. _how_to_build_on_arm:
2
3 ===================================================================
4 How To Build On ARM
5 ===================================================================
6
7 .. sectionauthor:: Wei-Ren Chen (陳韋任) <chenwj@iis.sinica.edu.tw>
8
9 Introduction
10 ============
11
12 This document contains information about building/testing LLVM and
13 Clang on ARM.
14
15 Notes On Building LLVM/Clang on ARM
16 =====================================
17 Here are some notes on building/testing LLVM/Clang on ARM. Note that
18 ARM encompasses a wide variety of CPUs; this advice is primarily based
19 on the ARMv6 and ARMv7 architectures and may be inapplicable to older chips.
20
21 #. If you are building LLVM/Clang on an ARM board with 1G of memory or less,
22    please use ``gold`` rather then GNU ``ld``.
23    Building LLVM/Clang with ``--enable-optimized``
24    is prefered since it consumes less memory. Otherwise, the building
25    process will very likely fail due to insufficient memory. In any
26    case it is probably a good idea to set up a swap partition.
27
28 #. If you want to run ``make
29    check-all`` after building LLVM/Clang, to avoid false alarms (eg, ARCMT
30    failure) please use the following configuration:
31
32    .. code-block:: bash
33
34      $ ../$LLVM_SRC_DIR/configure --with-abi=aapcs