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