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