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