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