Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 9acd4123169000288ee08aeb0fda021a47ed8cc7 / . / llvm / docs / index.html
blob: 2429b86a30a3841a39c9176a3e3f4fac4e262fd2 [file] [log] [blame]
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]3<html>
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]4<head>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]5 <title>The LLVM Compiler Infrastructure documentation</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]7</head>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]8<body>
9
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]10<div class="doc_title">The LLVM Compiler Infrastructure Documentation</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]11
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]12<div class="doc_text">
13<ul>
14 <li><a href="#getStarted">Getting started using LLVM</a></li>
15 <li><a href="#questions">Ask questions, get answers</a></li>
16 <li><a href="#docs">LLVM documentation</a></li>
17 <li><a href="#mailList">LLVM mailing lists</a></li>
18</ul>
19</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]20
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]21<!-- *********************************************************************** -->
22<div class="doc_section">
23 <a name="getStarted">Getting Started with LLVM</a>
24</div>
25<!-- *********************************************************************** -->
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]26
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]27<div class="doc_text">
28<ul>
Misha Brukman60349222004-05-13 16:37:23 +0000[diff] [blame]29<li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm/LICENSE.TXT?rev=HEAD&amp;content-type=text/x-cvsweb-markup">Distribution license</a></li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]30<li><a href="GettingStarted.html">Installing and compiling LLVM
31components</a></li>
32<li><a href="ReleaseNotes.html">Features and limitations of this release</a>
33</li>
34<li>
35<a href="WritingAnLLVMPass.html">How to write a pass within the LLVM system</a>
36</li>
37<li><a href="Projects.html">Start a new development project using LLVM</a></li>
38</ul>
39</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]40
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]41<!-- *********************************************************************** -->
42<div class="doc_section"><a name="questions">Questions &amp; Answers</a></div>
43<!-- *********************************************************************** -->
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]44
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]45<div class="doc_text">
46<ul>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]47
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]48<li>If you have questions or development problems not answered in the
49documentation, send e-mail to <a
50href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM-dev</a>. This
51mailing list is monitored by all the people in the LLVM group at Illinois, and
52you should expect prompt first responses.</li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]53
Misha Brukman0c058192004-05-14 18:54:04 +0000[diff] [blame]54<li>Please read <a href="HowToSubmitABug.html">How to submit a bug</a> for tips
55on how to track down bugs to their correct originating component -- sometimes,
56it's a bug in external software and not in LLVM, or for help with debugging your
57own LLVM passes and extensions.</li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]58
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]59<li>We now use <a href="http://llvm.cs.uiuc.edu/bugs/query.cgi">Bugzilla</a> to
60track bugs, so you can submit bugs and check their progress in real-time.</li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]61
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]62</ul>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]63
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]64</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]65
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]66<!-- *********************************************************************** -->
67<div class="doc_section"><a name="docs">LLVM Documentation</a></div>
68<!-- *********************************************************************** -->
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]69
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]70<div class="doc_text">
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]71
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]72<p>All the documents mentioned below except the design overview tech report
73are included as part of the LLVM release (in <tt>llvm/docs/*</tt>):</p>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]74
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]75</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]76
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]77<!-- ======================================================================= -->
78<div class="doc_subsection">LLVM Design Overview</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]79
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]80<div class="doc_text">
81<p><a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
82Compilation Framework for Lifelong Program Analysis &amp; Transformation</a></p>
83</div>
84
85<!-- ======================================================================= -->
86<div class="doc_subsection">
87 LLVM User Guides
88</div>
89
90<div class="doc_text">
91<ul>
92<li><a href="GettingStarted.html">Download and Installation
93Instructions</a></li>
94<li><a href="CommandGuide/index.html">LLVM Command Guide</a></li>
95<li><a href="LangRef.html">LLVM Assembly Language</a></li>
96<li><a href="TestingGuide.html">LLVM Test Suite Guide</a></li>
97</ul>
98</div>
99
100<!-- ======================================================================= -->
101<div class="doc_subsection">LLVM Programming Documentation</div>
102
103<div class="doc_text">
104<ul>
105<li><a href="ProgrammersManual.html">LLVM Programmers Manual</a></li>
106<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a></li>
107<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a></li>
108<li><a href="SourceLevelDebugging.html">Source Level Debugging with
109LLVM</a></li>
110<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a></li>
111<li><a href="Stacker.html">The Stacker Cronicles</a> - This document describes
112both the Stacker language and LLVM frontend, but also some details about LLVM
113useful for those writing front-ends.</li>
114<li><a href="CommandLine.html">Command Line Library</a></li>
115<li><a href="ExtendingLLVM.html">Extending LLVM</a></li>
116<li><a href="CodingStandards.html">Coding Standards</a></li>
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame^]117<li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]118</ul>
119</div>
120
121<!-- ======================================================================= -->
122<div class="doc_subsection">Other LLVM Resources</div>
123
124<div class="doc_text">
125<ul>
126<li><a href="CFEBuildInstrs.html">Building the LLVM C/C++ front-end</a></li>
127<li><a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">Submitting a
128bug</a></li>
129<li><a href="OpenProjects.html">Open projects</a></li>
130<li><a href="Projects.html">Creating a new LLVM project</a></li>
131</ul>
132</div>
133
134<!-- *********************************************************************** -->
135<div class="doc_section"><a name="mailList">Mailing Lists</a></div>
136<!-- *********************************************************************** -->
137
138<div class="doc_text">
139
140<p>There are three mailing lists for providing LLVM users with information:</p>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]141
142<ol>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]143
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]144<li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">LLVM
145Announcements List</a>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]146
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]147<p>This is a low volume list that provides important announcements regarding
148LLVM. It is primarily intended to announce new releases, major updates to the
149software, etc. This list is highly recommended for anyone that uses
150LLVM.</p></li>
151
152<li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developers
153List</a>
154
155<p>This list is for people who want to be included in technical discussions of
156LLVM. People post to this list when they have questions about writing code for
157or using the LLVM tools. It is relatively low volume.</p></li>
158
159<li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">LLVM Commits
160List</a>
161
162<p>This list contains all commit messages that are made when LLVM developers
163commit code changes to the CVS archive. It is useful for those who want to
164stay on the bleeding edge of LLVM development. This list is very high
165volume.</p></li>
166
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]167</ol>
168
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]169</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]170
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]171<!-- *********************************************************************** -->
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]172
173<hr>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]174<address>
175 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
176 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
177 <a href="http://validator.w3.org/check/referer"><img
178 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]179
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]180 <a href="mailto:criswell [at] cs.uiuc.edu">John Criswell</a><br>
181 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
182 Last modified: $Date$
183</address>
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]184
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]185</body>
186</html>