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