llvm/docs/index.html
Reid Spencer 500266187c Added an initial template/overview for documentation of the LLVM Bytecode
file format. This format is being extracted from the source code and the
small recesses of Chris' brain.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@13625 91177308-0d34-0410-b5e6-96231b3b80d8
2004-05-22 02:28:36 +00:00

187 lines
6.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>The LLVM Compiler Infrastructure documentation</title>
<link rel="stylesheet" href="llvm.css" type="text/css">
</head>
<body>
<div class="doc_title">The LLVM Compiler Infrastructure Documentation</div>
<div class="doc_text">
<ul>
<li><a href="#getStarted">Getting started using LLVM</a></li>
<li><a href="#questions">Ask questions, get answers</a></li>
<li><a href="#docs">LLVM documentation</a></li>
<li><a href="#mailList">LLVM mailing lists</a></li>
</ul>
</div>
<!-- *********************************************************************** -->
<div class="doc_section">
<a name="getStarted">Getting Started with LLVM</a>
</div>
<!-- *********************************************************************** -->
<div class="doc_text">
<ul>
<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>
<li><a href="GettingStarted.html">Installing and compiling LLVM
components</a></li>
<li><a href="ReleaseNotes.html">Features and limitations of this release</a>
</li>
<li>
<a href="WritingAnLLVMPass.html">How to write a pass within the LLVM system</a>
</li>
<li><a href="Projects.html">Start a new development project using LLVM</a></li>
</ul>
</div>
<!-- *********************************************************************** -->
<div class="doc_section"><a name="questions">Questions &amp; Answers</a></div>
<!-- *********************************************************************** -->
<div class="doc_text">
<ul>
<li>If you have questions or development problems not answered in the
documentation, send e-mail to <a
href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM-dev</a>. This
mailing list is monitored by all the people in the LLVM group at Illinois, and
you should expect prompt first responses.</li>
<li>Please read <a href="HowToSubmitABug.html">How to submit a bug</a> for tips
on how to track down bugs to their correct originating component -- sometimes,
it's a bug in external software and not in LLVM, or for help with debugging your
own LLVM passes and extensions.</li>
<li>We now use <a href="http://llvm.cs.uiuc.edu/bugs/query.cgi">Bugzilla</a> to
track bugs, so you can submit bugs and check their progress in real-time.</li>
</ul>
</div>
<!-- *********************************************************************** -->
<div class="doc_section"><a name="docs">LLVM Documentation</a></div>
<!-- *********************************************************************** -->
<div class="doc_text">
<p>All the documents mentioned below except the design overview tech report
are included as part of the LLVM release (in <tt>llvm/docs/*</tt>):</p>
</div>
<!-- ======================================================================= -->
<div class="doc_subsection">LLVM Design Overview</div>
<div class="doc_text">
<p><a href="http://llvm.cs.uiuc.edu/pubs/2004-01-30-CGO-LLVM.html">LLVM: A
Compilation Framework for Lifelong Program Analysis &amp; Transformation</a></p>
</div>
<!-- ======================================================================= -->
<div class="doc_subsection">
LLVM User Guides
</div>
<div class="doc_text">
<ul>
<li><a href="GettingStarted.html">Download and Installation
Instructions</a></li>
<li><a href="CommandGuide/index.html">LLVM Command Guide</a></li>
<li><a href="LangRef.html">LLVM Assembly Language</a></li>
<li><a href="TestingGuide.html">LLVM Test Suite Guide</a></li>
</ul>
</div>
<!-- ======================================================================= -->
<div class="doc_subsection">LLVM Programming Documentation</div>
<div class="doc_text">
<ul>
<li><a href="ProgrammersManual.html">LLVM Programmers Manual</a></li>
<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a></li>
<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a></li>
<li><a href="SourceLevelDebugging.html">Source Level Debugging with
LLVM</a></li>
<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a></li>
<li><a href="Stacker.html">The Stacker Cronicles</a> - This document describes
both the Stacker language and LLVM frontend, but also some details about LLVM
useful for those writing front-ends.</li>
<li><a href="CommandLine.html">Command Line Library</a></li>
<li><a href="ExtendingLLVM.html">Extending LLVM</a></li>
<li><a href="CodingStandards.html">Coding Standards</a></li>
<li><a href="BytecodeFormat.html">LLVM Bytecode File Format</a></li>
</ul>
</div>
<!-- ======================================================================= -->
<div class="doc_subsection">Other LLVM Resources</div>
<div class="doc_text">
<ul>
<li><a href="CFEBuildInstrs.html">Building the LLVM C/C++ front-end</a></li>
<li><a href="http://llvm.cs.uiuc.edu/docs/HowToSubmitABug.html">Submitting a
bug</a></li>
<li><a href="OpenProjects.html">Open projects</a></li>
<li><a href="Projects.html">Creating a new LLVM project</a></li>
</ul>
</div>
<!-- *********************************************************************** -->
<div class="doc_section"><a name="mailList">Mailing Lists</a></div>
<!-- *********************************************************************** -->
<div class="doc_text">
<p>There are three mailing lists for providing LLVM users with information:</p>
<ol>
<li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">LLVM
Announcements List</a>
<p>This is a low volume list that provides important announcements regarding
LLVM. It is primarily intended to announce new releases, major updates to the
software, etc. This list is highly recommended for anyone that uses
LLVM.</p></li>
<li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developers
List</a>
<p>This list is for people who want to be included in technical discussions of
LLVM. People post to this list when they have questions about writing code for
or using the LLVM tools. It is relatively low volume.</p></li>
<li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">LLVM Commits
List</a>
<p>This list contains all commit messages that are made when LLVM developers
commit code changes to the CVS archive. It is useful for those who want to
stay on the bleeding edge of LLVM development. This list is very high
volume.</p></li>
</ol>
</div>
<!-- *********************************************************************** -->
<hr>
<address>
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img
src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
<a href="http://validator.w3.org/check/referer"><img
src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a>
<a href="mailto:criswell [at] cs.uiuc.edu">John Criswell</a><br>
<a href="http://llvm.cs.uiuc.edu">LLVM Compiler Infrastructure</a><br>
Last modified: $Date$
</address>
</body>
</html>