Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / d6cf0d4d4fece53526bed7551366077a0a8d0a50 / . / docs / index.html
blob: 022d23e59a7b215e59930cbf460f7f434c54a5a3 [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>
Misha Brukmand6cf0d42004-03-08 17:59:31 +0000[diff] [blame^]51 <a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm/LICENSE.TXT?rev=HEAD&content-type=text/x-cvsweb-markup">llvm/LICENSE.TXT</a>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]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>
Chris Lattner8b1dc162004-02-22 05:45:02 +0000[diff] [blame]123 LLVM: A Compilation Framework for Lifelong Program Analysis
124 &amp; Transformation
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]125 <dd>
Chris Lattner8b1dc162004-02-22 05:45:02 +0000[diff] [blame]126 <a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">
127 http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html </a>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]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>
Chris Lattner5852a2b2004-02-06 20:27:41 +0000[diff] [blame]186 Source Level Debugging with LLVM:
187 <dd>
188 <a href="SourceLevelDebugging.html"> llvm/docs/SourceLevelDebugging.html</a>
189 <p>
190
191
192 <dt>
Chris Lattnerb54c99c2004-02-06 05:42:53 +0000[diff] [blame]193 TableGen Fundamentals:
194 <dd>
195 <a href="TableGenFundamentals.html"> llvm/docs/TableGenFundamentals.html</a>
196 <p>
197
198
199 <dt>
Chris Lattner22e46862003-11-25 03:32:57 +0000[diff] [blame]200 The Stacker Cronicles
201 <dd>
202 <a href="Stacker.html">The Stacker Cronicles</a>
203 - This document describes both the Stacker language and
204 LLVM frontend, but also some details about LLVM useful for
205 those writing front-ends.<p>
206
207
208 <dt>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]209 Command Line Library:
210 <dd>
211 <a href="CommandLine.html"> llvm/docs/CommandLine.html</a>
212 <p>
213
214 <dt>
215 Coding Standards:
216 <dd>
217 <a href="CodingStandards.html"> llvm/docs/CodingStandards.html</a>
218 <p>
219</dl>
220
221<h3>
222Other LLVM Resources:
223</h3>
224
225<dl compact>
226 <dt>
Misha Brukman36e96e02003-10-30 01:19:16 +0000[diff] [blame]227 Building the LLVM C/C++ front-end:
228 <dd>
229 <a href="CFEBuildInstrs.html">llvm/docs/CFEBuildInstrs.html</a>
230 <p>
231 <dt>
John Criswell0f6d7c02003-10-27 18:18:16 +0000[diff] [blame]232 Submitting a Bug:
233 <dd>
234 <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
235 http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
236 <p>
237
238 <dt>
239 Open Projects:
240 <dd>
241 <a href="OpenProjects.html"> llvm/docs/OpenProjects.html</a>
242 <p>
243
244 <dt>
245 Creating a new LLVM Project:
246 <dd>
247 <a href="Projects.html"> llvm/docs/Projects.html</a>
248 <p>
249</dl>
250
251<hr>
252
253<h2>
254Mailing Lists
255</h2>
256There are three mailing lists for providing LLVM users with information:
257
258<ol>
259 <li> LLVM Announcements List:<br>
260 <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
261 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce</a>
262
263 <p>
264 This is a low volume list that provides important announcements regarding
265 LLVM. It is primarily intended to announce new releases, major updates to
266 the software, etc. This list is highly recommended for anyone that uses
267 LLVM.
268 </p>
269
270 <li> LLVM Developers List:<br>
271 <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">
272 http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev</a>
273
274 <p>
275 This list is for people who want to be included in technical discussions
276 of LLVM. People post to this list when they have questions about writing
277 code for or using the LLVM tools. It is relatively low volume.
278 </p>
279
280 <li> LLVM Commits List<br>
281 <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">
282 http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits</a>
283
284 <p>
285 This list contains all commit messages that are made when LLVM developers
286 commit code changes to the CVS archive. It is useful for those who want to
287 stay on the bleeding edge of LLVM development. This list is very high
288 volume.
289 </p>
290</ol>
291</body>
292</html>
293