docs/index.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   6   <title>Documentation for the LLVM System at SVN head</title>
   7   <link rel="stylesheet" href="llvm.css" type="text/css">
   8 </head>
   9 <body>
  10
  11 <h1>Documentation for the LLVM System at SVN head</h1>
  12
  13 <p class="doc_warning">If you are using a released version of LLVM,
  14 see <a href="http://llvm.org/releases/">the download page</a> to find
  15 your documentation.</p>
  16
  17 <table class="layout" width="95%"><tr class="layout"><td class="left">
  18 <ul>
  19   <li><a href="#llvmdesign">LLVM Design</a></li>
  20   <li><a href="/pubs/">LLVM Publications</a></li>
  21   <li><a href="#userguide">LLVM User Guides</a></li>
  22   <li><a href="#llvmprog">LLVM Programming Documentation</a></li>
  23   <li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
  24   <li><a href="#develprocess">LLVM Development Process Documentation</a></li>
  25   <li><a href="#maillist">LLVM Mailing Lists</a></li>
  26 </ul>
  27 </td><td class="right">
  28   <form action="http://www.google.com/search" method=get>
  29     <p>
  30       <input type="hidden" name="sitesearch" value="llvm.org/docs">
  31       <input type=text name=q size=25><br>
  32       <input type=submit value="Search the LLVM Docs" name="submit">
  33     </p>
  34   </form>
  35 </td></tr></table>
  36
  37 <div class="doc_author">
  38   <p>Written by <a href="http://llvm.org/">The LLVM Team</a></p>
  39 </div>
  40
  41 <!--=======================================================================-->
  42 <h2><a name="llvmdesign">LLVM Design &amp; Overview</a></h2>
  43 <!--=======================================================================-->
  44
  45 <ul>
  46 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
  47 intermediate representation.</li>
  48 <li><a href="http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html">Introduction to the LLVM Compiler </a> - Presentation providing a users introduction to LLVM.</li>
  49 <li><a href="http://www.aosabook.org/en/llvm.html">Intro to LLVM</a> - book chapter providing a compiler hacker's introduction to LLVM.</li>
  50 <li><a href="http://llvm.org/pubs/2004-01-30-CGO-LLVM.html">LLVM: A Compilation Framework for
  51 Lifelong Program Analysis &amp; Transformation</a> - Design overview.</li>
  52 <li><a href="http://llvm.org/pubs/2002-12-LattnerMSThesis.html">LLVM: An Infrastructure for
  53 Multi-Stage Optimization</a> - More details (quite old now).</li>
  54 <li><a href="GetElementPtr.html">GetElementPtr FAQ</a> - Answers to some very
  55 frequent questions about LLVM's most frequently misunderstood instruction.</li>
  56 </ul>
  57
  58 <!--=======================================================================-->
  59 <h2><a name="userguide">LLVM User Guides</a></h2>
  60 <!--=======================================================================-->
  61
  62 <ul>
  63 <li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
  64 Discusses how to get up and running quickly with the LLVM infrastructure.
  65 Everything from unpacking and compilation of the distribution to execution of
  66 some tools.</li>
  67
  68 <li><a href="CMake.html">LLVM CMake guide</a> - An addendum to the main Getting
  69 Started guide for those using the <a href="http://www.cmake.org/">CMake build
  70 system</a>.
  71 </li>
  72
  73 <li><a href="GettingStartedVS.html">Getting Started with the LLVM System using
  74 Microsoft Visual Studio</a> - An addendum to the main Getting Started guide for
  75 those using Visual Studio on Windows.</li>
  76
  77 <li><a href="tutorial/">LLVM Tutorial</a> - A walk through the process of using
  78 LLVM for a custom language, and the facilities LLVM offers in tutorial form.</li>
  79 <li><a href="DeveloperPolicy.html">Developer Policy</a> - The LLVM project's
  80 policy towards developers and their contributions.</li>
  81
  82 <li><a href="CommandGuide/index.html">LLVM Command Guide</a> - A reference
  83 manual for the LLVM command line utilities ("man" pages for LLVM tools).</li>
  84
  85 <li><a href="Passes.html">LLVM's Analysis and Transform Passes</a> - A list of
  86 optimizations and analyses implemented in LLVM.</li>
  87
  88 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
  89 questions and problems and their solutions.</li>
  90
  91 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
  92 - This describes new features, known bugs, and other limitations.</li>
  93
  94 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
  95 Instructions for properly submitting information about any bugs you run into in
  96 the LLVM system.</li>
  97
  98 <li><a href="TestingGuide.html">LLVM Testing Infrastructure Guide</a> - A reference
  99 manual for using the LLVM testing infrastructure.</li>
 100
 101 <li><a href="http://clang.llvm.org/get_started.html">How to build the C, C++, ObjC,
 102 and ObjC++ front end</a> - Instructions for building the clang front-end from
 103 source.</li>
 104
 105 <li><a href="Packaging.html">Packaging guide</a> - Advice on packaging
 106 LLVM into a distribution.</li>
 107
 108 <li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
 109 and concepts used in LLVM.</li>
 110
 111 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
 112 channel</a>.  We often are on irc.oftc.net in the #llvm channel.  If you are
 113 using the mozilla browser, and have chatzilla installed, you can <a
 114 href="irc://irc.oftc.net/llvm">join #llvm on irc.oftc.net</a> directly.</li>
 115
 116 <li><a href="HowToAddABuilder.html">How To Add Your Build Configuration
 117 To LLVM Buildbot Infrastructure</a> - Instructions for adding new builder to
 118 LLVM buildbot master.</li>
 119
 120 </ul>
 121
 122
 123 <!--=======================================================================-->
 124 <h2><a name="llvmprog">LLVM Programming Documentation</a></h2>
 125 <!--=======================================================================-->
 126
 127 <ul>
 128 <li><a href="LangRef.html">LLVM Language Reference Manual</a> - Defines the LLVM
 129 intermediate representation and the assembly form of the different nodes.</li>
 130
 131 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
 132 Introduction to the general layout of the LLVM sourcebase, important classes
 133 and APIs, and some tips &amp; tricks.</li>
 134
 135 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
 136 Provides information on using the command line parsing library.</li>
 137
 138 <li><a href="CodingStandards.html">LLVM Coding standards</a> -
 139 Details the LLVM coding standards and provides useful information on writing
 140 efficient C++ code.</li>
 141
 142 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
 143 to add instructions and intrinsics to LLVM.</li>
 144
 145 <li><a href="http://llvm.org/doxygen/">Doxygen generated
 146 documentation</a> (<a
 147 href="http://llvm.org/doxygen/inherits.html">classes</a>)
 148
 149 (<a href="http://llvm.org/doxygen/doxygen.tar.gz">tarball</a>)
 150 </li>
 151
 152 <li><a href="http://llvm.org/viewvc/">ViewVC Repository Browser</a></li>
 153
 154 </ul>
 155
 156 <!--=======================================================================-->
 157 <h2><a name="subsystems">LLVM Subsystem Documentation</a></h2>
 158 <!--=======================================================================-->
 159
 160 <ul>
 161
 162 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
 163 on how to write LLVM transformations and analyses.</li>
 164
 165 <li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
 166 on how to write LLVM backends for machine targets.</li>
 167
 168 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
 169 Generator</a> - The design and implementation of the LLVM code generator.
 170 Useful if you are working on retargetting LLVM to a new architecture, designing
 171 a new codegen pass, or enhancing existing components.</li>
 172
 173 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
 174 Describes the TableGen tool, which is used heavily by the LLVM code
 175 generator.</li>
 176
 177 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
 178 on how to write a new alias analysis implementation or how to use existing
 179 analyses.</li>
 180
 181 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
 182 LLVM</a> - The interfaces source-language compilers should use for compiling
 183 GC'd programs.</li>
 184
 185 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
 186 LLVM</a> - This document describes the design and philosophy behind the LLVM
 187 source-level debugger.</li>
 188
 189 <li><a href="ExceptionHandling.html">Zero Cost Exception handling in LLVM</a>
 190 - This document describes the design and implementation of exception handling
 191 in LLVM.</li>
 192
 193 <li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
 194 reducer description and usage information.</li>
 195
 196 <li><a href="BitCodeFormat.html">LLVM Bitcode File Format</a> - This describes
 197 the file format and encoding used for LLVM "bc" files.</li>
 198
 199 <li><a href="SystemLibrary.html">System Library</a> - This document describes
 200 the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
 201 portable</li>
 202
 203 <li><a href="LinkTimeOptimization.html">Link Time Optimization</a> - This
 204 document describes the interface between LLVM intermodular optimizer and
 205 the linker and its design</li>
 206
 207 <li><a href="GoldPlugin.html">The LLVM gold plugin</a> - How to build your
 208 programs with link-time optimization on Linux.</li>
 209
 210 <li><a href="DebuggingJITedCode.html">The GDB JIT interface</a> - How to debug
 211 JITed code with GDB.</li>
 212
 213 <li><a href="BranchWeightMetadata.html">Branch Weight Metadata</a> - Provides
 214 information about Branch Prediction Information.</li>
 215
 216 </ul>
 217
 218 <!--=======================================================================-->
 219 <h2><a name="develprocess">LLVM Development Process Documentation</a></h2>
 220 <!--=======================================================================-->
 221
 222 <ul>
 223
 224 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
 225 templates for new projects that <em>use</em> the LLVM infrastructure.  The
 226 templates (directory organization, Makefiles, and test tree) allow the project
 227 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
 228 header files and libraries.</li>
 229
 230 <li><a href="LLVMBuild.html">LLVMBuild Documentation</a> - Describes the
 231 LLVMBuild organization and files used by LLVM to specify component
 232 descriptions.</li>
 233
 234 <li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
 235 LLVM makefiles work and how to use them.</li>
 236
 237 <li><a href="HowToReleaseLLVM.html">How To Release LLVM To The Public</a> - This
 238 is a guide to preparing LLVM releases. Most developers can ignore it.</li>
 239
 240 </ul>
 241
 242 <!--=======================================================================-->
 243 <h2><a name="maillist">LLVM Mailing Lists</a></h2>
 244 <!--=======================================================================-->
 245
 246 <ul>
 247 <li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce">
 248 LLVM Announcements List</a>: This is a low volume list that provides important
 249 announcements regarding LLVM.  It gets email about once a month.</li>
 250
 251 <li>The <a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
 252 List</a>: This list is for people who want to be included in technical
 253 discussions of LLVM. People post to this list when they have questions about
 254 writing code for or using the LLVM tools. It is relatively low volume.</li>
 255
 256 <li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
 257 Patches Archive</a>: This list gets emailed every time a bug is opened and
 258 closed, and when people submit patches to be included in LLVM.  It is higher
 259 volume than the LLVMdev list.</li>
 260
 261 <li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-commits/">Commits
 262 Archive</a>: This list contains all commit messages that are made when LLVM
 263 developers commit code changes to the repository. It is useful for those who
 264 want to stay on the bleeding edge of LLVM development. This list is very high
 265 volume.</li>
 266
 267 <li>The <a href="http://lists.cs.uiuc.edu/pipermail/llvm-testresults/">
 268 Test Results Archive</a>: A message is automatically sent to this list by every
 269 active nightly tester when it completes.  As such, this list gets email several
 270 times each day, making it a high volume list.</li>
 271
 272 </ul>
 273
 274 <!-- *********************************************************************** -->
 275
 276 <hr>
 277 <address>
 278   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 279   src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a>
 280   <a href="http://validator.w3.org/check/referer"><img
 281   src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a>
 282
 283   <a href="http://llvm.org/">LLVM Compiler Infrastructure</a><br>
 284   Last modified: $Date$
 285 </address>
 286 </body></html>