Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / dfe6a86b0bb2dd2233a05887d7bd6da26f9982b7 / . / llvm / docs / index.html
blob: 2eabed69472227ddb2c20ea33ab7e5510404f272 [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>
Chris Lattner0fc190f2004-07-09 05:05:39 +0000[diff] [blame]5 <title>Documentation for the LLVM System</title>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]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
Chris Lattner0fc190f2004-07-09 05:05:39 +0000[diff] [blame]10<div class="doc_title">Documentation for the LLVM System</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>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]14 <li><a href="#llvmdesign">LLVM Design</a></li>
15 <li><a href="#userguide">LLVM User Guides</a></li>
16 <li><a href="#llvmprog">General LLVM Programming Documentation</a></li>
17 <li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
Chris Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]18 <li><a href="#maillist">LLVM Mailing Lists</a></li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]19</ul>
20</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]21
Chris Lattnere1972b12004-08-02 21:33:45 +0000[diff] [blame]22<div class="doc_author">
23 <p>Written by <a href="http://llvm.cs.uiuc.edu">The LLVM Team</a></p>
24</div>
25
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]26<!--=======================================================================-->
27<div class="doc_section"><a name="llvmdesign">LLVM Design</a></div>
28<!--=======================================================================-->
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]29
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]30<ul>
Misha Brukman6e8f8602004-09-09 16:18:40 +0000[diff] [blame]31<li><a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
32Compilation Framework for Lifelong Program Analysis &amp; Transformation</a>: -
33Describes the LLVM instruction set and compilation strategy. This should be the
34first document you read to get an overview of LLVM.</li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]35
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]36<li><a href="LangRef.html">LLVM Reference Manual</a> - Defines the LLVM
37intermediate representation, the assembly form of the different nodes, and
38provides reference information about the different tools in LLVM.</li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]39
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]40<li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]41
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]42</ul>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]43
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]44<!--=======================================================================-->
45<div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
46<!--=======================================================================-->
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]47
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]48<ul>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]49<li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
50Discusses how to get up and running quickly with the LLVM infrastructure.
51Everything from unpacking and compilation of the distribution to execution of
52some tools.</li>
53
John Criswell23c656d2004-08-16 15:19:02 +0000[diff] [blame]54<li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
Reid Spencer9df63b42004-11-01 21:57:35 +0000[diff] [blame]55manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
56Current tools:
Reid Spencere4485002004-11-11 09:30:00 +0000[diff] [blame]57 <a href="CommandGuide/html/llvm-ar.html">llvm-ar</a>,
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame^]58 <a href="CommandGuide/html/llvm-ranlib.html">llvm-ranlib</a>,
Reid Spencer9df63b42004-11-01 21:57:35 +0000[diff] [blame]59 <a href="CommandGuide/html/llvm-as.html">llvm-as</a>,
60 <a href="CommandGuide/html/llvm-dis.html">llvm-dis</a>,
61 <a href="CommandGuide/html/opt.html">opt</a>,
62 <a href="CommandGuide/html/llc.html">llc</a>,
63 <a href="CommandGuide/html/lli.html">lli</a>,
64 <a href="CommandGuide/html/llvm-link.html">llvm-link</a>,
65 <a href="CommandGuide/html/analyze.html">analyze</a>,
66 <a href="CommandGuide/html/llvm-nm.html">llvm-nm</a>,
67 <a href="CommandGuide/html/llvm-prof.html">llvm-prof</a>,
68 <a href="CommandGuide/html/llvmgcc.html">llvmgcc</a>,
69 <a href="CommandGuide/html/llvmgxx.html">llvmgxx</a>,
70 <a href="CommandGuide/html/gccas.html">gccas</a>,
71 <a href="CommandGuide/html/gccld.html">gccld</a>,
72 <a href="CommandGuide/html/stkrc.html">stkrc</a>,
73 <a href="CommandGuide/html/bugpoint.html">bugpoint</a>,
74 <a href="CommandGuide/html/extract.html">extract</a>,
75 <a href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
76 <a href="CommandGuide/html/llvmc.html">llvmc</a>
77</li>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]78
Chris Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]79<li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
80questions and problems and their solutions.</li>
81
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]82<li><a href="ReleaseNotes.html">Release notes for the current release</a>
83- This describes new features, known bugs, and other limitations.</li>
84
85<li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
86Instructions for properly submitting information about any bugs you run into in
87the LLVM system.</li>
88
89<li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
90manual for using the LLVM test suite.</li>
91
92<li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
93Instructions for building the front-end from source.</li>
Chris Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]94
Chris Lattner85927a62004-09-19 23:15:47 +0000[diff] [blame]95<li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
96and concepts used in LLVM.</li>
97
Chris Lattnerbaf2b6e2004-08-02 21:37:11 +0000[diff] [blame]98<li><a name="irc">You can probably find help on the unofficial LLVM IRC
99channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
Misha Brukmana196c682004-09-06 20:58:44 +0000[diff] [blame]100using the mozilla browser, and have chatzilla installed, you can <a
101href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
Chris Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]102
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]103</ul>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]104
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]105
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]106<!--=======================================================================-->
107<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
108<!--=======================================================================-->
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]109
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]110<ul>
111<li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
112Introduction to the general layout of the LLVM sourcebase, important classes
113and APIs, and some tips &amp; tricks.</li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]114
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]115<li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
116templates for new projects that <em>use</em> the LLVM infrastructure. The
117templates (directory organization, Makefiles, and test tree) allow the project
118code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
119header files and libraries.</li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]120
Chris Lattner024627b2004-10-25 19:39:46 +0000[diff] [blame]121<li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
122LLVM makefiles work and how to use them.</li>
123
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]124<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
125Provides information on using the command line parsing library.</li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]126
Chris Lattner024627b2004-10-25 19:39:46 +0000[diff] [blame]127<li><a href="CodingStandards.html">LLVM Coding standards</a> -
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]128Details the LLVM coding standards and provides useful information on writing
129efficient C++ code.</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]130
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]131<li><a href="OpenProjects.html">Open Projects</a> - Look here if you are
132interested in doing something with LLVM but aren't sure what needs to be
133done.</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]134
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]135<li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
136to add instructions and intrinsics to LLVM.</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]137
Reid Spencer0b40fdb2004-10-31 23:02:38 +0000[diff] [blame]138<li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
139understand how to use the libraries produced when LLVM is compiled.</li>
140
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]141<li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
Misha Brukman9976d342004-12-03 23:26:23 +0000[diff] [blame]142documentation</a> (<a
143href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">classes</a>)</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]144
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]145<li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
146Browser</a></li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]147
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]148</ul>
149
150<!--=======================================================================-->
151<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
152<!--=======================================================================-->
153
154<ul>
155
156<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
157on how to write LLVM transformations and analyses.</li>
158
Misha Brukmana0194212004-09-06 23:00:01 +0000[diff] [blame]159<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
160on how to write LLVM backends for machine targets.</li>
161
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]162<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
163Generator</a> - The design and implementation of the LLVM code generator.
164Useful if you are working on retargetting LLVM to a new architecture, designing
165a new codegen pass, or enhancing existing components.</li>
166
167<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
168Describes the TableGen tool, which is used heavily by the LLVM code
169generator.</li>
170
171<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
172on how to write a new alias analysis implementation or how to use existing
173analyses.</li>
174
John Criswell8f002b62004-11-21 14:58:12 +0000[diff] [blame]175<li><a href="Stacker.html">The Stacker Chronicles</a> - This document
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]176describes both the Stacker language and LLVM frontend, but also some details
177about LLVM useful for those writing front-ends.</li>
178
179<li><a href="GarbageCollection.html">Accurate Garbage Collection with
180LLVM</a> - The interfaces source-language compilers should use for compiling
181GC'd programs.</li>
182
183<li><a href="SourceLevelDebugging.html">Source Level Debugging with
184LLVM</a> - This document describes the design and philosophy behind the LLVM
185source-level debugger.</li>
186
Misha Brukmanf4315372004-12-09 20:26:53 +0000[diff] [blame]187<li><a href="Bugpoint.html">bugpoint</a> - automatic bug finder and test-case
188reducer description and usage information.</li>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]189
Reid Spencercde8a13a2004-08-17 08:01:57 +0000[diff] [blame]190<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
191describes the design and configuration of the LLVM compiler driver tool,
192<tt>llvmc</tt>.</li>
193
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]194</ul>
195
196<!--=======================================================================-->
Chris Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]197<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]198<!--=======================================================================-->
199
200<ul>
201<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
202LLVM Announcements List</a>: This is a low volume list that provides important
203announcements regarding LLVM. It gets email about once a month.</li>
204
205<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
206List</a>: This list is for people who want to be included in technical
207discussions of LLVM. People post to this list when they have questions about
208writing code for or using the LLVM tools. It is relatively low volume.</li>
209
210<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
211Patches Archive</a>: This list gets emailed every time a bug is opened and
212closed, and when people submit patches to be included in LLVM. It is higher
213volume than the LLVMdev list.</li>
214
215<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
216Archive</a>: This list contains all commit messages that are made when LLVM
217developers commit code changes to the CVS archive. It is useful for those who
218want to stay on the bleeding edge of LLVM development. This list is very high
219volume.</li>
220
221</ul>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]222
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]223<!-- *********************************************************************** -->
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]224
225<hr>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]226<address>
227 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
228 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
229 <a href="http://validator.w3.org/check/referer"><img
230 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]231
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]232 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
233 Last modified: $Date$
234</address>
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]235