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>The LLVM Compiler Infrastructure documentation</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">The LLVM Compiler Infrastructure Documentation</div>
  11
  12 <div class="doc_text">
  13 <ul>
  14   <li><a href="#getStarted">Getting started using LLVM</a></li>
  15   <li><a href="#questions">Ask questions, get answers</a></li>
  16   <li><a href="#docs">LLVM documentation</a></li>
  17   <li><a href="#mailList">LLVM mailing lists</a></li>
  18 </ul>
  19 </div>
  20
  21 <!-- *********************************************************************** -->
  22 <div class="doc_section">
  23   <a name="getStarted">Getting Started with LLVM</a>
  24 </div>
  25 <!-- *********************************************************************** -->
  26
  27 <div class="doc_text">
  28 <ul>
  29 <li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm/LICENSE.TXT?rev=HEAD&amp;content-type=text/x-cvsweb-markup">Distribution license</a></li>
  30 <li><a href="GettingStarted.html">Installing and compiling LLVM
  31 components</a></li>
  32 <li><a href="ReleaseNotes.html">Features and limitations of this release</a>
  33 </li>
  34 <li>
  35 <a href="WritingAnLLVMPass.html">How to write a pass within the LLVM system</a>
  36 </li>
  37 <li><a href="Projects.html">Start a new development project using LLVM</a></li>
  38 </ul>
  39 </div>
  40
  41 <!-- *********************************************************************** -->
  42 <div class="doc_section"><a name="questions">Questions &amp; Answers</a></div>
  43 <!-- *********************************************************************** -->
  44
  45 <div class="doc_text">
  46 <ul>
  47
  48 <li>If you have questions or development problems not answered in the
  49 documentation, send e-mail to <a
  50 href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM-dev</a>.  This
  51 mailing list is monitored by all the people in the LLVM group at Illinois, and
  52 you should expect prompt first responses.</li>
  53
  54 <li>Please read <a href="HowToSubmitABug.html">How to submit a bug</a> for tips
  55 on how to track down bugs to their correct originating component -- sometimes,
  56 it's a bug in external software and not in LLVM, or for help with debugging your
  57 own LLVM passes and extensions.</li>
  58
  59 <li>We now use <a href="http://llvm.cs.uiuc.edu/bugs/query.cgi">Bugzilla</a> to
  60 track bugs, so you can submit bugs and check their progress in real-time.</li>
  61
  62 </ul>
  63
  64 </div>
  65
  66 <!-- *********************************************************************** -->
  67 <div class="doc_section"><a name="docs">LLVM Documentation</a></div>
  68 <!-- *********************************************************************** -->
  69
  70 <div class="doc_text">
  71
  72 <p>All the documents mentioned below except the design overview tech report
  73 are included as part of the LLVM release (in <tt>llvm/docs/*</tt>):</p>
  74
  75 </div>
  76
  77 <!-- ======================================================================= -->
  78 <div class="doc_subsection">LLVM Design Overview</div>
  79
  80 <div class="doc_text">
  81 <p><a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
  82 Compilation Framework for Lifelong Program Analysis &amp; Transformation</a></p>
  83 </div>
  84
  85 <!-- ======================================================================= -->
  86 <div class="doc_subsection">
  87   LLVM User Guides
  88 </div>
  89
  90 <div class="doc_text">
  91 <ul>
  92 <li><a href="GettingStarted.html">Download and Installation
  93 Instructions</a></li>
  94 <li><a href="CommandGuide/index.html">LLVM Command Guide</a></li>
  95 <li><a href="LangRef.html">LLVM Assembly Language</a></li>
  96 <li><a href="TestingGuide.html">LLVM Test Suite Guide</a></li>
  97 </ul>
  98 </div>
  99
 100 <!-- ======================================================================= -->
 101 <div class="doc_subsection">LLVM Programming Documentation</div>
 102
 103 <div class="doc_text">
 104 <ul>
 105 <li><a href="ProgrammersManual.html">LLVM Programmers Manual</a></li>
 106 <li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a></li>
 107 <li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a></li>
 108 <li><a href="SourceLevelDebugging.html">Source Level Debugging with
 109 LLVM</a></li>
 110 <li><a href="TableGenFundamentals.html">TableGen Fundamentals</a></li>
 111 <li><a href="Stacker.html">The Stacker Cronicles</a> - This document describes
 112 both the Stacker language and LLVM frontend, but also some details about LLVM
 113 useful for those writing front-ends.</li>
 114 <li><a href="CommandLine.html">Command Line Library</a></li>
 115 <li><a href="ExtendingLLVM.html">Extending LLVM</a></li>
 116 <li><a href="CodingStandards.html">Coding Standards</a></li>
 117 </ul>
 118 </div>
 119
 120 <!-- ======================================================================= -->
 121 <div class="doc_subsection">Other LLVM Resources</div>
 122
 123 <div class="doc_text">
 124 <ul>
 125 <li><a href="CFEBuildInstrs.html">Building the LLVM C/C++ front-end</a></li>
 126 <li><a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">Submitting a
 127 bug</a></li>
 128 <li><a href="OpenProjects.html">Open projects</a></li>
 129 <li><a href="Projects.html">Creating a new LLVM project</a></li>
 130 </ul>
 131 </div>
 132
 133 <!-- *********************************************************************** -->
 134 <div class="doc_section"><a name="mailList">Mailing Lists</a></div>
 135 <!-- *********************************************************************** -->
 136
 137 <div class="doc_text">
 138
 139 <p>There are three mailing lists for providing LLVM users with information:</p>
 140
 141 <ol>
 142
 143 <li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">LLVM
 144 Announcements List</a>
 145
 146 <p>This is a low volume list that provides important announcements regarding
 147 LLVM.  It is primarily intended to announce new releases, major updates to the
 148 software, etc.  This list is highly recommended for anyone that uses
 149 LLVM.</p></li>
 150
 151 <li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developers
 152 List</a>
 153
 154 <p>This list is for people who want to be included in technical discussions of
 155 LLVM.  People post to this list when they have questions about writing code for
 156 or using the LLVM tools.  It is relatively low volume.</p></li>
 157
 158 <li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">LLVM Commits
 159 List</a>
 160
 161 <p>This list contains all commit messages that are made when LLVM developers
 162 commit code changes to the CVS archive.  It is useful for those who want to
 163 stay on the bleeding edge of LLVM development. This list is very high
 164 volume.</p></li>
 165
 166 </ol>
 167
 168 </div>
 169
 170 <!-- *********************************************************************** -->
 171
 172 <hr>
 173 <address>
 174   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
 175   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
 176   <a href="http://validator.w3.org/check/referer"><img
 177   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
 178
 179   <a href="mailto:criswell [at] cs.uiuc.edu">John Criswell</a><br>
 180   <a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
 181   Last modified: $Date$
 182 </address>
 183
 184 </body>
 185 </html>