docs/index.html


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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288

<html>
<head>
  <title>The LLVM Compiler Infrastructure</title>
</head>
<body>

<center>
<h1>
                       The LLVM Compiler Infrastructure
                                 <br>
        <a href="http://llvm.cs.uiuc.edu">http://llvm.cs.uiuc.edu</a>
</h1>
</center>

<hr>

<h2>Welcome to LLVM!</h2>

This file is intended to do four things:
<ol>
  <li>help you get started using LLVM;</li>

  <li>tell you how to get questions about LLVM answered;</li>

  <li>tell you where to find documentation for different kinds of questions;
  and</li>

  <li>tell you about three LLVM-related mailing lists.</li>
</ol>


<hr>

<h2>
Getting Started with LLVM
</h2>

<dl compact>
    <dt>
    For license information:
    <dd>
        <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>
        <p>

    <dt>
    Installing and compiling LLVM:
    <dd>
        <a href="GettingStarted.html">llvm/docs/GettingStarted.html</a>
        <p>

    <dt>
    Learn about features and limitations of this release:
    <dd>
        <a href="ReleaseNotes.html">llvm/docs/ReleaseNotes.html</a>
        <p>

    <dt>
    Learn how to write a pass within the LLVM system:
    <dd>
        <a href="WritingAnLLVMPass.html">llvm/docs/WritingAnLLVMPass.html </a>
        <p>

    <dt>
    Learn how to start a new development project using LLVM, where your
    new source code can live anywhere (outside or inside the LLVM tree),
    while using LLVM header files and libraries:
    <dd>
        <a href="Projects.html">llvm/docs/Projects.html</a>
</dl>

<hr>

<h2>
Getting Help with LLVM
</h2>

<ol>
        <li>
        If you have questions or development problems not answered in the
        documentation, send e-mail to llvmdev@cs.uiuc.edu.  This mailing list is
        monitored by all the people in the LLVM group at Illinois, and you
        should expect prompt first responses.
        </li>

        <li>
        To report a bug, submit a bug report as described in the document:
        <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
        http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
        </li>

        <li>
        We now use Bugzilla to track bugs, so you can check the status of
        previous bugs at:
        <a href="http://llvm.cs.uiuc.edu/bugs/query.cgi">
        http://llvm.cs.uiuc.edu/bugs/query.cgi </a>
        </li>
</ol>

<hr>

<h2>
LLVM Documentation
</h2>

All the documents mentioned below except the design overview tech report
are included as part of the LLVM release (in llvm/docs/*):

<h3>
LLVM Design Overview:
</h3>

<dl compact>
    <dt>
     LLVM: A Compilation Framework for Lifelong Program Analysis 
     &amp; Transformation
    <dd>
        <a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">
        http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html </a>

</dl>

<h3>
LLVM User Guides:
</h3>

<dl compact>
    <dt>
    Download and Installation Instructions:
    <dd>
        <a href="GettingStarted.html"> llvm/docs/GettingStarted.html</a>
        <p>

    <dt>
    LLVM Command Guide:
    <dd>
        <a href="CommandGuide/index.html">
        llvm/docs/CommandGuide/index.html</a>
        <p>

    <dt>
    LLVM Assembly Language:
    <dd>
        <a href="LangRef.html"> llvm/docs/LangRef.html</a>
        <p>

    <dt>
    LLVM Test Suite Guide:
    <dd>
        <a href="TestingGuide.html"> llvm/docs/TestingGuide.html</a>
        <p>
</dl>

<h3>
LLVM Programming Documentation:
</h3>

<dl compact>
    <dt>
    LLVM Programmers Manual:
    <dd>
        <a href="ProgrammersManual.html">llvm/docs/ProgrammersManual.html</a>
        <p>

    <dt>
    Writing an LLVM Pass:
    <dd>
        <a href="WritingAnLLVMPass.html">llvm/docs/WritingAnLLVMPass.html</a>
        <p>

    <dt>
    Alias Analysis in LLVM:
    <dd>
        <a href="AliasAnalysis.html">llvm/docs/AliasAnalysis.html</a>
        <p>

    <dt>
    Source Level Debugging with LLVM:
    <dd>
        <a href="SourceLevelDebugging.html">llvm/docs/SourceLevelDebugging.html</a>
        <p>


    <dt>
    TableGen Fundamentals:
    <dd>
        <a href="TableGenFundamentals.html">llvm/docs/TableGenFundamentals.html</a>
        <p>


    <dt>
    The Stacker Cronicles
    <dd>
        <a href="Stacker.html">The Stacker Cronicles</a>
   - This document describes both the Stacker language and
                    LLVM frontend, but also some details about LLVM useful for
                    those writing front-ends.<p>


    <dt>
    Command Line Library:
    <dd>
        <a href="CommandLine.html">llvm/docs/CommandLine.html</a>
        <p>

    <dt>
    Extending LLVM:
    <dd>
        <a href="ExtendingLLVM.html">llvm/docs/ExtendingLLVM.html</a>
        <p>

    <dt>
    Coding Standards:
    <dd>
        <a href="CodingStandards.html">llvm/docs/CodingStandards.html</a>
        <p>
</dl>

<h3>Other LLVM Resources</h3>

<dl compact>
    <dt>
    Building the LLVM C/C++ front-end:
    <dd>
      <a href="CFEBuildInstrs.html">llvm/docs/CFEBuildInstrs.html</a>
      <p>
    <dt>
    Submitting a Bug:
    <dd>
        <a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">
        http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html</a>
        <p>

    <dt>
    Open Projects:
    <dd>
        <a href="OpenProjects.html">llvm/docs/OpenProjects.html</a>
        <p>

    <dt>
    Creating a new LLVM Project:
    <dd>
        <a href="Projects.html">llvm/docs/Projects.html</a>
        <p>
</dl>

<hr>

<h2>Mailing Lists</h2>

There are three mailing lists for providing LLVM users with information:

<ol>
    <li> LLVM Announcements List:<br>
    <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
    http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce</a>

    <p>
    This is a low volume list that provides important announcements regarding
    LLVM.  It is primarily intended to announce new releases, major updates to
    the software, etc.  This list is highly recommended for anyone that uses
    LLVM.
    </p>

    <li> LLVM Developers List:<br>
    <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">
    http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev</a>

    <p>
    This list is for people who want to be included in technical discussions
    of LLVM.  People post to this list when they have questions about writing
    code for or using the LLVM tools.  It is relatively low volume.
    </p>

    <li> LLVM Commits List<br>
    <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">
    http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits</a>

    <p>
    This list contains all commit messages that are made when LLVM developers
    commit code changes to the CVS archive.  It is useful for those who want to
    stay on the bleeding edge of LLVM development. This list is very high
    volume.
    </p>
</ol>

</body>
</html>