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