Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / fdfb25a9e17c691dcf2c8aa81779cb357af064b2 / . / llvm / docs / index.html
blob: c670fbc788704446ceed952d790236afebb529f2 [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">
Chris Lattnerc5ad1ca2005-04-23 15:55:18 +0000[diff] [blame]13<table class="layout" width="95%"><tr class="layout"><td class="left">
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]14<ul>
Chris Lattnerfcc76882004-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 Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]19 <li><a href="#maillist">LLVM Mailing Lists</a></li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]20</ul>
Chris Lattnerc5ad1ca2005-04-23 15:55:18 +0000[diff] [blame]21</td><td class="right">
22 <form action="http://www.google.com/search" method=get>
Chris Lattnerc5ad1ca2005-04-23 15:55:18 +0000[diff] [blame]23 <input type="hidden" name="sitesearch" value="llvm.cs.uiuc.edu/docs">
24 <input type=text name=q size=25><br>
25 <input type=submit value="Search the LLVM Docs" name="submit">
Chris Lattnerfdfb25a2005-04-23 17:27:36 +0000[diff] [blame^]26 </form>
Chris Lattnerc5ad1ca2005-04-23 15:55:18 +0000[diff] [blame]27</td></tr></table>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]28</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]29
Chris Lattnere1972b12004-08-02 21:33:45 +0000[diff] [blame]30<div class="doc_author">
31 <p>Written by <a href="http://llvm.cs.uiuc.edu">The LLVM Team</a></p>
32</div>
33
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]34<!--=======================================================================-->
35<div class="doc_section"><a name="llvmdesign">LLVM Design</a></div>
36<!--=======================================================================-->
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]37
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]38<ul>
Misha Brukman6e8f8602004-09-09 16:18:40 +0000[diff] [blame]39<li><a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]43
Chris Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]47
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]48<li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]49
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]50</ul>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]51
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]52<!--=======================================================================-->
53<div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
54<!--=======================================================================-->
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]55
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]56<ul>
Chris Lattnerfcc76882004-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 Cohenc04c0db2005-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 Criswell23c656d2004-08-16 15:19:02 +0000[diff] [blame]66<li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
Reid Spencer9df63b42004-11-01 21:57:35 +0000[diff] [blame]67manual for the LLVM command line utilities ("man" pages for LLVM tools).<br/>
68Current tools:
Reid Spencere4485002004-11-11 09:30:00 +0000[diff] [blame]69 <a href="CommandGuide/html/llvm-ar.html">llvm-ar</a>,
John Criswelldfe6a862004-12-10 15:51:16 +0000[diff] [blame]70 <a href="CommandGuide/html/llvm-ranlib.html">llvm-ranlib</a>,
Reid Spencer9df63b42004-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>,
86 <a href="CommandGuide/html/extract.html">extract</a>,
87 <a href="CommandGuide/html/llvm-bcanalyzer.html">llvm-bcanalyzer</a>,
88 <a href="CommandGuide/html/llvmc.html">llvmc</a>
89</li>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]90
Chris Lattner07414cb2004-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 Lattnerfcc76882004-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 Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]106
Chris Lattner85927a62004-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 Lattnerbaf2b6e2004-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 Brukmana196c682004-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 Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]114
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]115</ul>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]116
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]117
Chris Lattnerfcc76882004-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 Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]121
Chris Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]126
Chris Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]132
Chris Lattner024627b2004-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 Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]138
Chris Lattner024627b2004-10-25 19:39:46 +0000[diff] [blame]139<li><a href="CodingStandards.html">LLVM Coding standards</a> -
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]140Details the LLVM coding standards and provides useful information on writing
141efficient C++ code.</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]142
Chris Lattnerfcc76882004-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 Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]145
Reid Spencer0b40fdb2004-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
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]149<li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
Misha Brukman9976d342004-12-03 23:26:23 +0000[diff] [blame]150documentation</a> (<a
151href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">classes</a>)</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]152
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]153<li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
154Browser</a></li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]155
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]156</ul>
157
158<!--=======================================================================-->
159<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
160<!--=======================================================================-->
161
162<ul>
163
164<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
165on how to write LLVM transformations and analyses.</li>
166
Misha Brukmana0194212004-09-06 23:00:01 +0000[diff] [blame]167<li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
168on how to write LLVM backends for machine targets.</li>
169
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]170<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
171Generator</a> - The design and implementation of the LLVM code generator.
172Useful if you are working on retargetting LLVM to a new architecture, designing
173a new codegen pass, or enhancing existing components.</li>
174
175<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
176Describes the TableGen tool, which is used heavily by the LLVM code
177generator.</li>
178
179<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
180on how to write a new alias analysis implementation or how to use existing
181analyses.</li>
182
John Criswell8f002b62004-11-21 14:58:12 +0000[diff] [blame]183<li><a href="Stacker.html">The Stacker Chronicles</a> - This document
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]184describes both the Stacker language and LLVM frontend, but also some details
185about LLVM useful for those writing front-ends.</li>
186
187<li><a href="GarbageCollection.html">Accurate Garbage Collection with
188LLVM</a> - The interfaces source-language compilers should use for compiling
189GC'd programs.</li>
190
191<li><a href="SourceLevelDebugging.html">Source Level Debugging with
192LLVM</a> - This document describes the design and philosophy behind the LLVM
193source-level debugger.</li>
194
Misha Brukmana9ade832005-01-07 17:00:44 +0000[diff] [blame]195<li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
Misha Brukmanf4315372004-12-09 20:26:53 +0000[diff] [blame]196reducer description and usage information.</li>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]197
Reid Spencercde8a13a2004-08-17 08:01:57 +0000[diff] [blame]198<li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
199describes the design and configuration of the LLVM compiler driver tool,
200<tt>llvmc</tt>.</li>
201
Reid Spencer1d183c42005-01-05 19:01:20 +0000[diff] [blame]202<li><a href="SystemLibrary.html">System Library</a> - This document describes
203the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
204portable</li>
205
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]206</ul>
207
208<!--=======================================================================-->
Chris Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]209<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]210<!--=======================================================================-->
211
212<ul>
213<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
214LLVM Announcements List</a>: This is a low volume list that provides important
215announcements regarding LLVM. It gets email about once a month.</li>
216
217<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
218List</a>: This list is for people who want to be included in technical
219discussions of LLVM. People post to this list when they have questions about
220writing code for or using the LLVM tools. It is relatively low volume.</li>
221
222<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
223Patches Archive</a>: This list gets emailed every time a bug is opened and
224closed, and when people submit patches to be included in LLVM. It is higher
225volume than the LLVMdev list.</li>
226
227<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
228Archive</a>: This list contains all commit messages that are made when LLVM
229developers commit code changes to the CVS archive. It is useful for those who
230want to stay on the bleeding edge of LLVM development. This list is very high
231volume.</li>
232
233</ul>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]234
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]235<!-- *********************************************************************** -->
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]236
237<hr>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]238<address>
239 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
240 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
241 <a href="http://validator.w3.org/check/referer"><img
242 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]243
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]244 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
245 Last modified: $Date$
246</address>
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]247