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="output" value="googleabout">
  24       <input type="hidden" name="sitesearch" value="llvm.cs.uiuc.edu/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.cs.uiuc.edu">The LLVM Team</a></p>
  33 </div>
  34
  35 <!--=======================================================================-->
  36 <div class="doc_section"><a name="llvmdesign">LLVM Design</a></div>
  37 <!--=======================================================================-->
  38
  39 <ul>
  40 <li><a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
  41 Compilation Framework for Lifelong Program Analysis &amp; Transformation</a>: -
  42 Describes the LLVM instruction set and compilation strategy.  This should be the
  43 first document you read to get an overview of LLVM.</li>
  44
  45 <li><a href="LangRef.html">LLVM Reference Manual</a> - Defines the LLVM
  46 intermediate representation, the assembly form of the different nodes, and
  47 provides reference information about the different tools in LLVM.</li>
  48
  49 <li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></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/extract.html">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="ProgrammersManual.html">The LLVM Programmers Manual</a> -
 125 Introduction to the general layout of the LLVM sourcebase, important classes
 126 and APIs, and some tips &amp; tricks.</li>
 127
 128 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
 129 templates for new projects that <em>use</em> the LLVM infrastructure.  The
 130 templates (directory organization, Makefiles, and test tree) allow the project
 131 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
 132 header files and libraries.</li>
 133
 134 <li><a href="MakefileGuide.html">LLVM Makefile Guide</a> - Describes how the
 135 LLVM makefiles work and how to use them.</li>
 136
 137 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
 138 Provides information on using the command line parsing library.</li>
 139
 140 <li><a href="CodingStandards.html">LLVM Coding standards</a> -
 141 Details the LLVM coding standards and provides useful information on writing
 142 efficient C++ code.</li>
 143
 144 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
 145 to add instructions and intrinsics to LLVM.</li>
 146
 147 <li><a href="UsingLibraries.html">Using LLVM Libraries</a> - Look here to
 148 understand how to use the libraries produced when LLVM is compiled.</li>
 149
 150 <li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
 151 documentation</a> (<a
 152 href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">classes</a>)</li>
 153
 154 <li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
 155 Browser</a></li>
 156
 157 </ul>
 158
 159 <!--=======================================================================-->
 160 <div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
 161 <!--=======================================================================-->
 162
 163 <ul>
 164
 165 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
 166 on how to write LLVM transformations and analyses.</li>
 167
 168 <li><a href="WritingAnLLVMBackend.html">Writing an LLVM Backend</a> - Information
 169 on how to write LLVM backends for machine targets.</li>
 170
 171 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
 172 Generator</a> - The design and implementation of the LLVM code generator.
 173 Useful if you are working on retargetting LLVM to a new architecture, designing
 174 a new codegen pass, or enhancing existing components.</li>
 175
 176 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
 177 Describes the TableGen tool, which is used heavily by the LLVM code
 178 generator.</li>
 179
 180 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
 181 on how to write a new alias analysis implementation or how to use existing
 182 analyses.</li>
 183
 184 <li><a href="Stacker.html">The Stacker Chronicles</a> - This document
 185 describes both the Stacker language and LLVM frontend, but also some details
 186 about LLVM useful for those writing front-ends.</li>
 187
 188 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
 189 LLVM</a> - The interfaces source-language compilers should use for compiling
 190 GC'd programs.</li>
 191
 192 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
 193 LLVM</a> - This document describes the design and philosophy behind the LLVM
 194 source-level debugger.</li>
 195
 196 <li><a href="Bugpoint.html">Bugpoint</a> - automatic bug finder and test-case
 197 reducer description and usage information.</li>
 198
 199 <li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
 200 describes the design and configuration of the LLVM compiler driver tool,
 201 <tt>llvmc</tt>.</li>
 202
 203 <li><a href="SystemLibrary.html">System Library</a> - This document describes
 204 the LLVM System Library (<tt>lib/System</tt>) and how to keep LLVM source code
 205 portable</li>
 206
 207 </ul>
 208
 209 <!--=======================================================================-->
 210 <div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
 211 <!--=======================================================================-->
 212
 213 <ul>
 214 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
 215 LLVM Announcements List</a>: This is a low volume list that provides important
 216 announcements regarding LLVM.  It gets email about once a month.</li>
 217
 218 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
 219 List</a>: This list is for people who want to be included in technical
 220 discussions of LLVM. People post to this list when they have questions about
 221 writing code for or using the LLVM tools. It is relatively low volume.</li>
 222
 223 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
 224 Patches Archive</a>: This list gets emailed every time a bug is opened and
 225 closed, and when people submit patches to be included in LLVM.  It is higher
 226 volume than the LLVMdev list.</li>
 227
 228 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
 229 Archive</a>: This list contains all commit messages that are made when LLVM
 230 developers commit code changes to the CVS archive. It is useful for those who
 231 want to stay on the bleeding edge of LLVM development. This list is very high
 232 volume.</li>
 233
 234 </ul>
 235
 236 <!-- *********************************************************************** -->
 237
 238 <hr>
 239 <address>
 240   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 241   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 242   <a href="http://validator.w3.org/check/referer"><img
 243   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 244
 245   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
 246   Last modified: $Date$
 247 </address>
 248