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