1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
5 <title>Documentation for the LLVM System</title>
6 <link rel="stylesheet" href="llvm.css" type="text/css">
10 <div class="doc_title">Documentation for the LLVM System</div>
12 <div class="doc_text">
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>
18 <li><a href="#maillist">LLVM Mailing Lists</a></li>
22 <div class="doc_author">
23 <p>Written by <a href="http://llvm.cs.uiuc.edu">The LLVM Team</a></p>
26 <!--=======================================================================-->
27 <div class="doc_section"><a name="llvmdesign">LLVM Design</a></div>
28 <!--=======================================================================-->
31 <li><a href="pubs/2004-01-30-CGO-LLVM.html"> LLVM: A Compilation Framework for
32 Lifelong Program Analysis & Transformation</a>: - Describes
33 the LLVM instruction set and compilation strategy. This should be the first
34 document you read to get an overview of LLVM.</li>
36 <li><a href="LangRef.html">LLVM Reference Manual</a> - Defines the LLVM
37 intermediate representation, the assembly form of the different nodes, and
38 provides reference information about the different tools in LLVM.</li>
40 <li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
44 <!--=======================================================================-->
45 <div class="doc_section"><a name="userguide">LLVM User Guides</a></div>
46 <!--=======================================================================-->
49 <li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
50 Discusses how to get up and running quickly with the LLVM infrastructure.
51 Everything from unpacking and compilation of the distribution to execution of
54 <li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
55 manual for the LLVM command line utilities ("man" pages for LLVM tools).</li>
57 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
58 questions and problems and their solutions.</li>
60 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
61 - This describes new features, known bugs, and other limitations.</li>
63 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
64 Instructions for properly submitting information about any bugs you run into in
67 <li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
68 manual for using the LLVM test suite.</li>
70 <li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
71 Instructions for building the front-end from source.</li>
73 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
74 channel</a>. We often are on irc.oftc.net in the #llvm channel. If you are
75 using the mozilla browser, and have chatzilla installed, you can join by <a
76 href="irc://irc.oftc.net/llvm">clicking here</a>.</li>
81 <!--=======================================================================-->
82 <div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
83 <!--=======================================================================-->
86 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
87 Introduction to the general layout of the LLVM sourcebase, important classes
88 and APIs, and some tips & tricks.</li>
90 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
91 templates for new projects that <em>use</em> the LLVM infrastructure. The
92 templates (directory organization, Makefiles, and test tree) allow the project
93 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
94 header files and libraries.</li>
96 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
97 Provides information on using the command line parsing library.</li>
99 <li><a href="CodingStandards.html">Recommended LLVM Coding standards</a> -
100 Details the LLVM coding standards and provides useful information on writing
101 efficient C++ code.</li>
103 <li><a href="OpenProjects.html">Open Projects</a> - Look here if you are
104 interested in doing something with LLVM but aren't sure what needs to be
107 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
108 to add instructions and intrinsics to LLVM.</li>
110 <li><a href="CodingStandards.html">Coding Standards</a> - Guidelines for
111 hacking LLVM source.</li>
113 <li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
114 documentation</a> (<a href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">
117 <li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
122 <!--=======================================================================-->
123 <div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
124 <!--=======================================================================-->
128 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
129 on how to write LLVM transformations and analyses.</li>
131 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
132 Generator</a> - The design and implementation of the LLVM code generator.
133 Useful if you are working on retargetting LLVM to a new architecture, designing
134 a new codegen pass, or enhancing existing components.</li>
136 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
137 Describes the TableGen tool, which is used heavily by the LLVM code
140 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
141 on how to write a new alias analysis implementation or how to use existing
144 <li><a href="Stacker.html">The Stacker Cronicles</a> - This document
145 describes both the Stacker language and LLVM frontend, but also some details
146 about LLVM useful for those writing front-ends.</li>
148 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
149 LLVM</a> - The interfaces source-language compilers should use for compiling
152 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
153 LLVM</a> - This document describes the design and philosophy behind the LLVM
154 source-level debugger.</li>
156 <li><a href="Bugpoint.html">Bugpoint</a> automatic bug finder and
157 test-case reducer description and usage information.</li>
161 <!--=======================================================================-->
162 <div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
163 <!--=======================================================================-->
166 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
167 LLVM Announcements List</a>: This is a low volume list that provides important
168 announcements regarding LLVM. It gets email about once a month.</li>
170 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
171 List</a>: This list is for people who want to be included in technical
172 discussions of LLVM. People post to this list when they have questions about
173 writing code for or using the LLVM tools. It is relatively low volume.</li>
175 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &
176 Patches Archive</a>: This list gets emailed every time a bug is opened and
177 closed, and when people submit patches to be included in LLVM. It is higher
178 volume than the LLVMdev list.</li>
180 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
181 Archive</a>: This list contains all commit messages that are made when LLVM
182 developers commit code changes to the CVS archive. It is useful for those who
183 want to stay on the bleeding edge of LLVM development. This list is very high
188 <!-- *********************************************************************** -->
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>
197 <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
198 Last modified: $Date$