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