Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 0f6d7c0e20a67a0e6be2bff6d4d83cfeb149c17f / . / docs / index.html
blob: b2db1ba85862c57d1e9153422c988f1a94bb9af5 [file] [log] [blame]
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame^]1<html>
2<title>
3The LLVM Compiler Infrastructure
4</title>
5
6<body>
7
8<center>
9<h1>
10 The LLVM Compiler Infrastructure
11 <br>
12 <a href="http://llvm.cs.uiuc.edu">http://llvm.cs.uiuc.edu</a>
13</h1>
14</center>
15
16<hr>
17
18<h2>
19Welcome to LLVM!
20</h2>
21This file is intended to do four things:
22<ol>
23 <li>
24 help you get started using LLVM;
25 </li>
26
27 <li>
28 tell you how to get questions about LLVM answered;
29 </li>
30
31 <li>
32 tell you where to find documentation for different kinds of questions; and
33 </li>
34
35 <li>
36 tell you about three LLVM-related mailing lists.
37 </li>
38</ol>
39
40
41<hr>
42
43<h2>
44Getting Started with LLVM
45</h2>
46
47<dl compact>
48 <dt>
49 For license information:
50 <dd>
51 <a href="../LICENSE.TXT">llvm/LICENSE.TXT</a>
52 <p>
53
54 <dt>
55 Installing and compiling LLVM:
56 <dd>
57 <a href="GettingStarted.html">llvm/docs/GettingStarted.html</a>
58 <p>
59
60 <dt>
61 Learn about features and limitations of this release:
62 <dd>
63 <a href="ReleaseNotes.html">llvm/docs/ReleaseNotes.html</a>
64 <p>
65
66 <dt>
67 Learn how to write a pass within the LLVM system:
68 <dd>
69 <a href="WritingAnLLVMPass.html">llvm/docs/WritingAnLLVMPass.html </a>
70 <p>
71
72 <dt>
73 Learn how to start a new development project using LLVM, where your
74 new source code can live anywhere (outside or inside the LLVM tree),
75 while using LLVM header files and libraries:
76 <dd>
77 <a href="Projects.html">llvm/docs/Projects.html</a>
78</dl>
79
80<hr>
81
82<h2>
83Getting Help with LLVM
84</h2>
85
86<ol>
87 <li>
88 If you have questions or development problems not answered in the
89 documentation, send e-mail to llvmdev@cs.uiuc.edu. This mailing list is
90 monitored by all the people in the LLVM group at Illinois, and you
91 should expect prompt first responses.
92 </li>
93
94 <li>
95 To report a bug, submit a bug report as described in the document:
96 <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
97 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
98 </li>
99
100 <li>
101 We now use Bugzilla to track bugs, so you can check the status of
102 previous bugs at:
103 <a href="http://llvm.cs.uiuc.edu/bugs/query.cgi">
104 http://llvm.cs.uiuc.edu/bugs/query.cgi </a>
105 </li>
106</ol>
107
108<hr>
109
110<h2>
111LLVM Documentation
112</h2>
113
114All the documents mentioned below except the design overview tech report
115are included as part of the LLVM release (in llvm/docs/*):
116
117<h3>
118LLVM Design Overview:
119</h3>
120
121<dl compact>
122 <dt>
123 LLVM : A Compilation Framework for Lifelong Program Analysis
124 and Transformation:
125 <dd>
126 <a href="http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html">
127 http://llvm.cs.uiuc.edu/pubs/2003-09-30-LifelongOptimizationTR.html </a>
128
129</dl>
130
131<h3>
132LLVM User Guides:
133</h3>
134
135<dl compact>
136 <dt>
137 Download and Installation Instructions:
138 <dd>
139 <a href="GettingStarted.html"> llvm/docs/GettingStarted.html</a>
140 <p>
141
142 <dt>
143 LLVM Command Guide:
144 <dd>
145 <a href="CommandGuide/index.html">
146 llvm/docs/CommandGuide/index.html</a>
147 <p>
148
149 <dt>
150 LLVM Assembly Language:
151 <dd>
152 <a href="LangRef.html"> llvm/docs/LangRef.html</a>
153 <p>
154
155 <dt>
156 LLVM Test Suite Guide:
157 <dd>
158 <a href="TestingGuide.html"> llvm/docs/TestingGuide.html</a>
159 <p>
160</dl>
161
162<h3>
163LLVM Programming Documentation:
164</h3>
165
166<dl compact>
167 <dt>
168 LLVM Programmers Manual:
169 <dd>
170 <a href="ProgrammersManual.html"> llvm/docs/ProgrammersManual.html</a>
171 <p>
172
173 <dt>
174 Writing an LLVM Pass:
175 <dd>
176 <a href="WritingAnLLVMPass.html"> llvm/docs/WritingAnLLVMPass.html</a>
177 <p>
178
179 <dt>
180 Alias Analysis in LLVM:
181 <dd>
182 <a href="AliasAnalysis.html"> llvm/docs/AliasAnalysis.html</a>
183 <p>
184
185 <dt>
186 Command Line Library:
187 <dd>
188 <a href="CommandLine.html"> llvm/docs/CommandLine.html</a>
189 <p>
190
191 <dt>
192 Coding Standards:
193 <dd>
194 <a href="CodingStandards.html"> llvm/docs/CodingStandards.html</a>
195 <p>
196</dl>
197
198<h3>
199Other LLVM Resources:
200</h3>
201
202<dl compact>
203 <dt>
204 Submitting a Bug:
205 <dd>
206 <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
207 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
208 <p>
209
210 <dt>
211 Open Projects:
212 <dd>
213 <a href="OpenProjects.html"> llvm/docs/OpenProjects.html</a>
214 <p>
215
216 <dt>
217 Creating a new LLVM Project:
218 <dd>
219 <a href="Projects.html"> llvm/docs/Projects.html</a>
220 <p>
221</dl>
222
223<hr>
224
225<h2>
226Mailing Lists
227</h2>
228There are three mailing lists for providing LLVM users with information:
229
230<ol>
231 <li> LLVM Announcements List:<br>
232 <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
233 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce</a>
234
235 <p>
236 This is a low volume list that provides important announcements regarding
237 LLVM. It is primarily intended to announce new releases, major updates to
238 the software, etc. This list is highly recommended for anyone that uses
239 LLVM.
240 </p>
241
242 <li> LLVM Developers List:<br>
243 <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">
244 http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev</a>
245
246 <p>
247 This list is for people who want to be included in technical discussions
248 of LLVM. People post to this list when they have questions about writing
249 code for or using the LLVM tools. It is relatively low volume.
250 </p>
251
252 <li> LLVM Commits List<br>
253 <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">
254 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits</a>
255
256 <p>
257 This list contains all commit messages that are made when LLVM developers
258 commit code changes to the CVS archive. It is useful for those who want to
259 stay on the bleeding edge of LLVM development. This list is very high
260 volume.
261 </p>
262</ol>
263</body>
264</html>
265