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="pubs/2004-01-30-CGO-LLVM.html"> LLVM: A Compilation Framework for
  32 Lifelong Program Analysis &amp; Transformation</a>: - Describes
  33 the LLVM instruction set and compilation strategy.  This should be the first
  34 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).</li>
  56
  57 <li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
  58 questions and problems and their solutions.</li>
  59
  60 <li><a href="ReleaseNotes.html">Release notes for the current release</a>
  61 - This describes new features, known bugs, and other limitations.</li>
  62
  63 <li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
  64 Instructions for properly submitting information about any bugs you run into in
  65 the LLVM system.</li>
  66
  67 <li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
  68 manual for using the LLVM test suite.</li>
  69
  70 <li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
  71 Instructions for building the front-end from source.</li>
  72
  73 <li><a name="irc">You can probably find help on the unofficial LLVM IRC
  74 channel</a>.  We often are on irc.oftc.net in the #llvm channel.  If you are
  75 using the mozilla browser, and have chatzilla installed, you can join by <a
  76 href="irc://irc.oftc.net/llvm">clicking here</a>.</li>
  77
  78 </ul>
  79
  80
  81 <!--=======================================================================-->
  82 <div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
  83 <!--=======================================================================-->
  84
  85 <ul>
  86 <li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
  87 Introduction to the general layout of the LLVM sourcebase, important classes
  88 and APIs, and some tips &amp; tricks.</li>
  89
  90 <li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
  91 templates for new projects that <em>use</em> the LLVM infrastructure.  The
  92 templates (directory organization, Makefiles, and test tree) allow the project
  93 code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
  94 header files and libraries.</li>
  95
  96 <li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
  97 Provides information on using the command line parsing library.</li>
  98
  99 <li><a href="CodingStandards.html">Recommended LLVM Coding standards</a> -
 100 Details the LLVM coding standards and provides useful information on writing
 101 efficient C++ code.</li>
 102
 103 <li><a href="OpenProjects.html">Open Projects</a> - Look here if you are
 104 interested in doing something with LLVM but aren't sure what needs to be
 105 done.</li>
 106
 107 <li><a href="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
 108 to add instructions and intrinsics to LLVM.</li>
 109
 110 <li><a href="CodingStandards.html">Coding Standards</a> - Guidelines for
 111 hacking LLVM source.</li>
 112
 113 <li><a href="Lexicon.html">The LLVM Lexicon</a> - Definition of acronyms, terms
 114 and concepts used in LLVM.</li>
 115
 116 <li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
 117 documentation</a> (<a href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">
 118 classes</a>)</li>
 119
 120 <li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
 121 Browser</a></li>
 122
 123 </ul>
 124
 125 <!--=======================================================================-->
 126 <div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
 127 <!--=======================================================================-->
 128
 129 <ul>
 130
 131 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
 132 on how to write LLVM transformations and analyses.</li>
 133
 134 <li><a href="CodeGenerator.html">The LLVM Target-Independent Code
 135 Generator</a> - The design and implementation of the LLVM code generator.
 136 Useful if you are working on retargetting LLVM to a new architecture, designing
 137 a new codegen pass, or enhancing existing components.</li>
 138
 139 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
 140 Describes the TableGen tool, which is used heavily by the LLVM code
 141 generator.</li>
 142
 143 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
 144 on how to write a new alias analysis implementation or how to use existing
 145 analyses.</li>
 146
 147 <li><a href="Stacker.html">The Stacker Cronicles</a> - This document
 148 describes both the Stacker language and LLVM frontend, but also some details
 149 about LLVM useful for those writing front-ends.</li>
 150
 151 <li><a href="GarbageCollection.html">Accurate Garbage Collection with
 152 LLVM</a> - The interfaces source-language compilers should use for compiling
 153 GC'd programs.</li>
 154
 155 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
 156 LLVM</a> - This document describes the design and philosophy behind the LLVM
 157 source-level debugger.</li>
 158
 159 <li><a href="Bugpoint.html">Bugpoint</a> automatic bug finder and
 160 test-case reducer description and usage information.</li>
 161
 162 <li><a href="CompilerDriver.html">Compiler Driver (llvmc)</a> - This document
 163 describes the design and configuration of the LLVM compiler driver tool,
 164 <tt>llvmc</tt>.</li>
 165
 166 </ul>
 167
 168 <!--=======================================================================-->
 169 <div class="doc_section"><a name="maillist">LLVM Mailing Lists</a></div>
 170 <!--=======================================================================-->
 171
 172 <ul>
 173 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
 174 LLVM Announcements List</a>: This is a low volume list that provides important
 175 announcements regarding LLVM.  It gets email about once a month.</li>
 176
 177 <li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
 178 List</a>: This list is for people who want to be included in technical
 179 discussions of LLVM. People post to this list when they have questions about
 180 writing code for or using the LLVM tools. It is relatively low volume.</li>
 181
 182 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &amp;
 183 Patches Archive</a>: This list gets emailed every time a bug is opened and
 184 closed, and when people submit patches to be included in LLVM.  It is higher
 185 volume than the LLVMdev list.</li>
 186
 187 <li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
 188 Archive</a>: This list contains all commit messages that are made when LLVM
 189 developers commit code changes to the CVS archive. It is useful for those who
 190 want to stay on the bleeding edge of LLVM development. This list is very high
 191 volume.</li>
 192
 193 </ul>
 194
 195 <!-- *********************************************************************** -->
 196
 197 <hr>
 198 <address>
 199   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 200   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 201   <a href="http://validator.w3.org/check/referer"><img
 202   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 203
 204   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
 205   Last modified: $Date$
 206 </address>
 207