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