blob: d75769a793899c2a4799d633dae20736de6525b0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
User Guides
===========
For those new to the LLVM system.
NOTE: If you are a user who is only interested in using an LLVM-based compiler,
you should look into `Clang <http://clang.llvm.org>`_ instead. The
documentation here is intended for users who have a need to work with the
intermediate LLVM representation.
.. toctree::
:hidden:
CMake
CMakePrimer
AdvancedBuilds
HowToBuildOnARM
HowToBuildWithPGO
HowToCrossCompileBuiltinsOnArm
HowToCrossCompileLLVM
yaml2obj
MarkdownQuickstartTemplate
Phabricator
Passes
YamlIO
GetElementPtr
Frontend/PerformanceTips
MCJITDesignAndImplementation
ORCv2
CodeOfConduct
CompileCudaWithLLVM
ReportingGuide
Benchmarking
Docker
BuildingADistribution
Remarks
Building, Packaging, and Distributing LLVM
------------------------------------------
How to build, package, and distribute LLVM.
=====
CMake
=====
:doc:`BuildingADistribution`
A best-practices guide for using LLVM's CMake build system to package and
distribute LLVM-based tools.
:doc:`CMake`
An addendum to the main Getting Started guide for those using the `CMake
build system <http://www.cmake.org>`_.
=====
Clang
=====
:doc:`HowToBuildOnARM`
Notes on building and testing LLVM/Clang on ARM.
:doc:`HowToBuildWithPGO`
Notes on building LLVM/Clang with PGO.
:doc:`HowToCrossCompileLLVM`
Notes on cross-building and testing LLVM/Clang.
`How to build the C, C++, ObjC, and ObjC++ front end`__
Instructions for building the clang front-end from source.
.. __: http://clang.llvm.org/get_started.html
======
Docker
======
:doc:`Docker`
A reference for using Dockerfiles provided with LLVM.
=================
Additional Topics
=================
:doc:`HowToCrossCompileBuiltinsOnArm`
Notes on cross-building and testing the compiler-rt builtins for Arm.
:doc:`Passes`
A list of optimizations and analyses implemented in LLVM.
:doc:`TestSuiteGuide`
Describes how to compile and run the test-suite benchmarks.
:doc:`YamlIO`
A reference guide for using LLVM's YAML I/O library.
:doc:`GetElementPtr`
Answers to some very frequent questions about LLVM's most frequently
misunderstood instruction.
:doc:`Frontend/PerformanceTips`
A collection of tips for frontend authors on how to generate IR
which LLVM is able to effectively optimize.
:doc:`Remarks`
A reference on the implementation of remarks in LLVM.
|
