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