Gitiles
Code Review Sign In
gerrit-public.fairphone.software / fp2-dev / platform / external / llvm / 7dbf813e82ed332a1c7c9ad3d2263df657752ad5 / . / docs / index.html
blob: bfcb1eaab37769d59818ef7ff4e19e893b635728 [file] [log] [blame]
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3<html>
4<head>
5 <title>Documentation for the LLVM System</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
7</head>
8<body>
9
10<div class="doc_title">Documentation for the LLVM System</div>
11
12<div class="doc_text">
13<table class="layout" width="95%"><tr class="layout"><td class="left">
14<ul>
15 <li><a href="#llvmdesign">LLVM Design</a></li>
16 <li><a href="/pubs/">LLVM Publications</a></li>
17 <li><a href="#userguide">LLVM User Guides</a></li>
18 <li><a href="#llvmprog">General LLVM Programming Documentation</a></li>
19 <li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
20 <li><a href="#maillist">LLVM Mailing Lists</a></li>
21</ul>
22</td><td class="right">
23 <form action="http://www.google.com/search" method=get>
24 <input type="hidden" name="sitesearch" value="llvm.org/docs">
25 <input type=text name=q size=25><br>
26 <input type=submit value="Search the LLVM Docs" name="submit">
27 </form>
28</td></tr></table>
29</div>
30
31<div class="doc_author">
32 <p>Written by <a href="http://llvm.org">The LLVM Team</a></p>
33</div>
34
35<!--=======================================================================-->
36<div class="doc_section"><a name="llvmdesign">LLVM Design &amp; Overview</a></div>
37<!--=======================================================================-->
38
39<ul>
40<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
41intermediate representation.</li>
42<li><a href="http://llvm.org/pubs/2006-04-25-GelatoLLVMIntro.html">Introduction to the LLVM Compiler Infrastructure</a> - Presentation describing LLVM.</li>
43<li><a href="http://llvm.org/pubs/2004-09-22-LCPCLLVMTutorial.html">The LLVM Compiler Framework and
44Infrastructure Tutorial</a> - Tutorial for writing passes, exploring the system.</li>
45<li><a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
46Lifelong Program Analysis &amp; Transformation</a> - Design overview.</li>
47<li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
48Multi-Stage Optimization</a> - More details (somewhat old now).</li>
49<li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
50frequent questions about LLVM's most frequently misunderstood instruction.</li>
51</ul>
52
53<!--=======================================================================-->
54<div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
55<!--=======================================================================-->
56
57<ul>
58<li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
59Discusses how to get up and running quickly with the LLVM infrastructure.
60Everything from unpacking and compilation of the distribution to execution of
61some tools.</li>
62
63<li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
64Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
65those using Visual Studio on Windows.</li>
66
Chris Lattnerb7da3a12007-11-09 19:24:54 +0000[diff] [blame]67<li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
Nick Lewycky345de762007-11-09 05:45:51 +0000[diff] [blame]68LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]69<li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
70policy towards developers and their contributions.</li>
71
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]72<li><a href="/docs/CommandGuide/index.html">LLVM Command Guide</a> - A reference
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]73manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
74Current tools:
Reid Spencer76f73d12007-08-05 23:43:44 +0000[diff] [blame]75 <a href="/cmds/llvm-ar.html">llvm-ar</a>,
76 <a href="/cmds/llvm-as.html">llvm-as</a>,
77 <a href="/cmds/llvm-dis.html">llvm-dis</a>,
78 <a href="/cmds/llvm-extract.html">llvm-extract</a>,
79 <a href="/cmds/llvm-ld.html">llvm-ld</a>,
80 <a href="/cmds/llvm-link.html">llvm-link</a>,
81 <a href="/cmds/llvm-nm.html">llvm-nm</a>,
82 <a href="/cmds/llvm-prof.html">llvm-prof</a>,
83 <a href="/cmds/llvm-ranlib.html">llvm-ranlib</a>,
84 <a href="/cmds/opt.html">opt</a>,
85 <a href="/cmds/llc.html">llc</a>,
86 <a href="/cmds/lli.html">lli</a>,
87 <a href="/cmds/llvmc.html">llvmc</a>
88 <a href="/cmds/llvmgcc.html">llvm-gcc</a>,
89 <a href="/cmds/llvmgxx.html">llvm-g++</a>,
90 <a href="/cmds/stkrc.html">stkrc</a>,
91 <a href="/cmds/bugpoint.html">bugpoint</a>,
92 <a href="/cmds/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]93</li>
94
Tanya Lattner79e6c772008-03-24 18:29:32 +0000[diff] [blame]95<li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of
96optimizations and analyses implemented in LLVM.</li>
97
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]98<li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
99questions and problems and their solutions.</li>
100
101<li><a href="ReleaseNotes.html">Release notes for the current release</a>
102- This describes new features, known bugs, and other limitations.</li>
103
104<li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
105Instructions for properly submitting information about any bugs you run into in
106the LLVM system.</li>
107
Matthijs Kooijmaneb69e792008-07-02 13:54:58 +0000[diff] [blame]108<li><a href="TestingGuide.html">LLVM Testing Infrastructure Guide</a> - A reference
109manual for using the LLVM testing infrastructure.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]110
Duncan Sands7dbf8132008-12-10 10:50:58 +0000[diff] [blame^]111<li><a href="GCCFEBuildInstrs.html">How to build the Ada/C/C++/Fortran front-ends</a> -
112Instructions for building gcc front-ends from source.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]113
114<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
115and concepts used in LLVM.</li>
116
117<li><a name="irc">You can probably find help on the unofficial LLVM IRC
118channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
119using the mozilla browser, and have chatzilla installed, you can <a
120href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
121
122</ul>
123
124
125<!--=======================================================================-->
126<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
127<!--=======================================================================-->
128
129<ul>
130<li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
131intermediate representation and the assembly form of the different nodes.</li>
132
133<li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
134Introduction to the general layout of the LLVM sourcebase, important classes
135and APIs, and some tips &amp; tricks.</li>
136
137<li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
138templates for new projects that <em>use</em> the LLVM infrastructure. The
139templates (directory organization, Makefiles, and test tree) allow the project
140code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
141header files and libraries.</li>
142
143<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
144LLVM makefiles work and how to use them.</li>
145
146<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
147Provides information on using the command line parsing library.</li>
148
149<li><a href="CodingStandards.html">LLVM Coding standards</a> -
150Details the LLVM coding standards and provides useful information on writing
151efficient C++ code.</li>
152
153<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
154to add instructions and intrinsics to LLVM.</li>
155
156<li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
157understand how to use the libraries produced when LLVM is compiled.</li>
158
159<li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
160is a guide to preparing LLVM releases. Most developers can ignore it.</li>
161
162<li><a href="http://llvm.org/doxygen/">Doxygen generated
163documentation</a> (<a
164href="http://llvm.org/doxygen/inherits.html">classes</a>)
165
166(<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
167</li>
168
169<li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
170
171</ul>
172
173<!--=======================================================================-->
174<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
175<!--=======================================================================-->
176
177<ul>
178
179<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
180on how to write LLVM transformations and analyses.</li>
181
182<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
183on how to write LLVM backends for machine targets.</li>
184
185<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
186Generator</a> - The design and implementation of the LLVM code generator.
187Useful if you are working on retargetting LLVM to a new architecture, designing
188a new codegen pass, or enhancing existing components.</li>
189
190<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
191Describes the TableGen tool, which is used heavily by the LLVM code
192generator.</li>
193
194<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
195on how to write a new alias analysis implementation or how to use existing
196analyses.</li>
197
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]198<li><a href="GarbageCollection.html">Accurate Garbage Collection with
199LLVM</a> - The interfaces source-language compilers should use for compiling
200GC'd programs.</li>
201
202<li><a href="SourceLevelDebugging.html">Source Level Debugging with
203LLVM</a> - This document describes the design and philosophy behind the LLVM
204source-level debugger.</li>
205
206<li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
207- This document describes the design and implementation of exception handling
208in LLVM.</li>
209
210<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
211reducer description and usage information.</li>
212
213<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
214describes the design and configuration of the LLVM compiler driver tool,
215<tt>llvmc</tt>.</li>
216
Chris Lattner6b118e12008-07-13 21:27:36 +0000[diff] [blame]217<li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a> - This describes
218the file format and encoding used for LLVM "bc" files.</li>
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]219
220<li><a href="SystemLibrary.html">System Library</a> - This document describes
221the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
222portable</li>
223
224<li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
225document describes the interface between LLVM intermodular optimizer and
226the linker and its design</li>
227
228</ul>
229
230
231<!--=======================================================================-->
232<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
233<!--=======================================================================-->
234
235<ul>
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]236<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]237LLVM Announcements List</a>: This is a low volume list that provides important
238announcements regarding LLVM. It gets email about once a month.</li>
239
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]240<li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]241List</a>: This list is for people who want to be included in technical
242discussions of LLVM. People post to this list when they have questions about
243writing code for or using the LLVM tools. It is relatively low volume.</li>
244
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]245<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]246Patches Archive</a>: This list gets emailed every time a bug is opened and
247closed, and when people submit patches to be included in LLVM. It is higher
248volume than the LLVMdev list.</li>
249
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]250<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/">Commits
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]251Archive</a>: This list contains all commit messages that are made when LLVM
252developers commit code changes to the repository. It is useful for those who
253want to stay on the bleeding edge of LLVM development. This list is very high
254volume.</li>
255
Duncan Sands2656aa32008-11-12 10:10:25 +0000[diff] [blame]256<li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
Dan Gohmanf17a25c2007-07-18 16:29:46 +0000[diff] [blame]257Test Results Archive</a>: A message is automatically sent to this list by every
258active nightly tester when it completes. As such, this list gets email several
259times each day, making it a high volume list.</li>
260
261</ul>
262
263<!-- *********************************************************************** -->
264
265<hr>
266<address>
267 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
268 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
269 <a href="http://validator.w3.org/check/referer"><img
270 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
271
272 <a href="http://llvm.org">LLVM Compiler Infrastructure</a><br>
273 Last modified: $Date$
274</address>
275</body></html>
Chris Lattner38bd5dd2007-09-21 17:30:40 +0000[diff] [blame]276