Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 23c656d050d03585c74d1d7f64e26e7d0856deec / . / llvm / docs / index.html
blob: 7f61fdef1b7194dd8a04857c9ec500301c2c5f5e [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">
13<ul>
Chris Lattnerfcc76882004-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 Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]18 <li><a href="#maillist">LLVM Mailing Lists</a></li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]19</ul>
20</div>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]21
Chris Lattnere1972b12004-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 Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]26<!--=======================================================================-->
27<div class="doc_section"><a name="llvmdesign">LLVM Design</a></div>
28<!--=======================================================================-->
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]29
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]30<ul>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]31<li><a href="pubs/2004-01-30-CGO-LLVM.html"> LLVM: A Compilation Framework for
32Lifelong Program Analysis &amp; Transformation</a>: - Describes
33the LLVM instruction set and compilation strategy. This should be the first
34document you read to get an overview of LLVM.</li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]35
Chris Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]39
Reid Spencer9acd4122004-05-22 02:28:36 +0000[diff] [blame]40<li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]41
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]42</ul>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]43
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]44<!--=======================================================================-->
45<div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
46<!--=======================================================================-->
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]47
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]48<ul>
Chris Lattnerfcc76882004-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 Criswell23c656d2004-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 Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]56
Chris Lattner07414cb2004-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 Lattnerfcc76882004-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 Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]72
Chris Lattnerbaf2b6e2004-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
75using the mozilla browser, and have chatzilla installed, you can join by <a
Chris Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]76href="irc://irc.oftc.net/llvm">clicking here</a>.</li>
77
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]78</ul>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]79
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]80
Chris Lattnerfcc76882004-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 Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]84
Chris Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]89
Chris Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]95
Chris Lattnerfcc76882004-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 Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]98
Chris Lattnerfcc76882004-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 Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]102
Chris Lattnerfcc76882004-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 Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]106
Chris Lattnerfcc76882004-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 Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]109
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]110<li><a href="CodingStandards.html">Coding Standards</a> - Guidelines for
111hacking LLVM source.</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]112
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]113<li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
114documentation</a> (<a href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">
115classes</a>)</li>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]116
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]117<li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
118Browser</a></li>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]119
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]120</ul>
121
122<!--=======================================================================-->
123<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
124<!--=======================================================================-->
125
126<ul>
127
128<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
129on how to write LLVM transformations and analyses.</li>
130
131<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
132Generator</a> - The design and implementation of the LLVM code generator.
133Useful if you are working on retargetting LLVM to a new architecture, designing
134a new codegen pass, or enhancing existing components.</li>
135
136<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
137Describes the TableGen tool, which is used heavily by the LLVM code
138generator.</li>
139
140<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
141on how to write a new alias analysis implementation or how to use existing
142analyses.</li>
143
144<li><a href="Stacker.html">The Stacker Cronicles</a> - This document
145describes both the Stacker language and LLVM frontend, but also some details
146about LLVM useful for those writing front-ends.</li>
147
148<li><a href="GarbageCollection.html">Accurate Garbage Collection with
149LLVM</a> - The interfaces source-language compilers should use for compiling
150GC'd programs.</li>
151
152<li><a href="SourceLevelDebugging.html">Source Level Debugging with
153LLVM</a> - This document describes the design and philosophy behind the LLVM
154source-level debugger.</li>
155
156<li><a href="Bugpoint.html">Bugpoint</a> automatic bug finder and
157test-case reducer description and usage information.</li>
158
159</ul>
160
161<!--=======================================================================-->
Chris Lattner07414cb2004-08-02 21:32:08 +0000[diff] [blame]162<div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
Chris Lattnerfcc76882004-08-02 21:29:20 +0000[diff] [blame]163<!--=======================================================================-->
164
165<ul>
166<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
167LLVM Announcements List</a>: This is a low volume list that provides important
168announcements regarding LLVM. It gets email about once a month.</li>
169
170<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
171List</a>: This list is for people who want to be included in technical
172discussions of LLVM. People post to this list when they have questions about
173writing code for or using the LLVM tools. It is relatively low volume.</li>
174
175<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
176Patches Archive</a>: This list gets emailed every time a bug is opened and
177closed, and when people submit patches to be included in LLVM. It is higher
178volume than the LLVMdev list.</li>
179
180<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
181Archive</a>: This list contains all commit messages that are made when LLVM
182developers commit code changes to the CVS archive. It is useful for those who
183want to stay on the bleeding edge of LLVM development. This list is very high
184volume.</li>
185
186</ul>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]187
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]188<!-- *********************************************************************** -->
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]189
190<hr>
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]191<address>
192 <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
193 src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
194 <a href="http://validator.w3.org/check/referer"><img
195 src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
John Criswellf531f312003-10-27 18:18:16 +0000[diff] [blame]196
Misha Brukman8e33fed2004-05-12 18:00:48 +0000[diff] [blame]197 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
198 Last modified: $Date$
199</address>
Misha Brukmanad3e28c2004-04-06 04:22:43 +0000[diff] [blame]200