mirror of
https://github.com/RPCS3/llvm.git
synced 2025-03-03 00:06:46 +00:00
Revamp the index page
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@15418 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Chris Lattner
parent
04db80862c
commit
2042302bb2
294
docs/index.html
294
docs/index.html
@ -1,3 +1,4 @@
|
||||
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
|
||||
"http://www.w3.org/TR/html4/strict.dtd">
|
||||
<html>
|
||||
@ -11,164 +12,189 @@
|
||||
|
||||
<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>
|
||||
<li><a href="#llvmdesign">LLVM Design</a></li>
|
||||
<li><a href="#userguide">LLVM User Guides</a></li>
|
||||
<li><a href="#llvmprog">General LLVM Programming Documentation</a></li>
|
||||
<li><a href="#subsystems">LLVM Subsystem Documentation</a></li>
|
||||
<li><a href="#Support">LLVM Support</a>
|
||||
<ul>
|
||||
<li><a href="#mailList">LLVM mailing lists</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<!-- *********************************************************************** -->
|
||||
<div class="doc_section">
|
||||
<a name="getStarted">Getting Started with LLVM</a>
|
||||
</div>
|
||||
<!-- *********************************************************************** -->
|
||||
<!--=======================================================================-->
|
||||
<div class="doc_section"><a name="llvmdesign">LLVM Design</a></div>
|
||||
<!--=======================================================================-->
|
||||
|
||||
<div class="doc_text">
|
||||
<ul>
|
||||
<li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm/LICENSE.TXT?rev=HEAD&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>
|
||||
<li><a href="pubs/2004-01-30-CGO-LLVM.html"> LLVM: A Compilation Framework for
|
||||
Lifelong Program Analysis & Transformation</a>: - Describes
|
||||
the LLVM instruction set and compilation strategy. This should be the first
|
||||
document you read to get an overview of LLVM.</li>
|
||||
|
||||
<!-- *********************************************************************** -->
|
||||
<div class="doc_section"><a name="questions">Questions & Answers</a></div>
|
||||
<!-- *********************************************************************** -->
|
||||
<li><a href="LangRef.html">LLVM Reference Manual</a> - Defines the LLVM
|
||||
intermediate representation, the assembly form of the different nodes, and
|
||||
provides reference information about the different tools in LLVM.</li>
|
||||
|
||||
<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 & 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>
|
||||
<li><a href="CFEBuildInstrs.html">Building the LLVM C/C++ front-end</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="CodeGenerator.html">The LLVM Target-Independent Code Generator</a></li>
|
||||
<li><a href="GarbageCollection.html">Accurate Garbage Collection with 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> - describes both the
|
||||
Stacker language and LLVM frontend, as well as 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_section"><a name="userguide">LLVM User Guides</a></div>
|
||||
<!--=======================================================================-->
|
||||
|
||||
<div class="doc_text">
|
||||
<ul>
|
||||
<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>
|
||||
<li><a href="GettingStarted.html">The LLVM Getting Started Guide</a> -
|
||||
Discusses how to get up and running quickly with the LLVM infrastructure.
|
||||
Everything from unpacking and compilation of the distribution to execution of
|
||||
some tools.</li>
|
||||
|
||||
<li><a href="CommandGuide/">LLVM Command Guide</a> - A reference manual for
|
||||
the LLVM command line utilities ("man" pages for LLVM tools).</li>
|
||||
|
||||
<li><a href="ReleaseNotes.html">Release notes for the current release</a>
|
||||
- This describes new features, known bugs, and other limitations.</li>
|
||||
|
||||
<li><a href="HowToSubmitABug.html">How to Submit A Bug Report</a> -
|
||||
Instructions for properly submitting information about any bugs you run into in
|
||||
the LLVM system.</li>
|
||||
|
||||
<li><a href="TestingGuide.html">LLVM Test Suite Guide</a> - A reference
|
||||
manual for using the LLVM test suite.</li>
|
||||
|
||||
<li><a href="CFEBuildInstrs.html">How to build the C/C++ front-end</a> -
|
||||
Instructions for building the front-end from source.</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<!-- *********************************************************************** -->
|
||||
<div class="doc_section"><a name="mailList">Mailing Lists</a></div>
|
||||
<!-- *********************************************************************** -->
|
||||
|
||||
<div class="doc_text">
|
||||
<!--=======================================================================-->
|
||||
<div class="doc_section"><a name="llvmprog">General LLVM Programming Documentation</a></div>
|
||||
<!--=======================================================================-->
|
||||
|
||||
<p>There are three mailing lists for providing LLVM users with information:</p>
|
||||
<ul>
|
||||
<li><a href="ProgrammersManual.html">The LLVM Programmers Manual</a> -
|
||||
Introduction to the general layout of the LLVM sourcebase, important classes
|
||||
and APIs, and some tips & tricks.</li>
|
||||
|
||||
<ol>
|
||||
<li><a href="Projects.html">LLVM Project Guide</a> - How-to guide and
|
||||
templates for new projects that <em>use</em> the LLVM infrastructure. The
|
||||
templates (directory organization, Makefiles, and test tree) allow the project
|
||||
code to be located outside (or inside) the <tt>llvm/</tt> tree, while using LLVM
|
||||
header files and libraries.</li>
|
||||
|
||||
<li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">LLVM
|
||||
Announcements List</a>
|
||||
<li><a href="CommandLine.html">CommandLine library Reference Manual</a> -
|
||||
Provides information on using the command line parsing library.</li>
|
||||
|
||||
<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="CodingStandards.html">Recommended LLVM Coding standards</a> -
|
||||
Details the LLVM coding standards and provides useful information on writing
|
||||
efficient C++ code.</li>
|
||||
|
||||
<li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">LLVM Developers
|
||||
List</a>
|
||||
<li><a href="OpenProjects.html">Open Projects</a> - Look here if you are
|
||||
interested in doing something with LLVM but aren't sure what needs to be
|
||||
done.</li>
|
||||
|
||||
<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="ExtendingLLVM.html">Extending LLVM</a> - Look here to see how
|
||||
to add instructions and intrinsics to LLVM.</li>
|
||||
|
||||
<li><a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-commits">LLVM Commits
|
||||
List</a>
|
||||
<li><a href="CodingStandards.html">Coding Standards</a> - Guidelines for
|
||||
hacking LLVM source.</li>
|
||||
|
||||
<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>
|
||||
<li><a href="http://llvm.cs.uiuc.edu/doxygen/">Doxygen generated
|
||||
documentation</a> (<a href="http://llvm.cs.uiuc.edu/doxygen/inherits.html">
|
||||
classes</a>)</li>
|
||||
|
||||
</ol>
|
||||
<li><a href="http://llvm.cs.uiuc.edu/cvsweb/cvsweb.cgi/llvm">CVSWeb CVS Tree
|
||||
Browser</a></li>
|
||||
|
||||
</div>
|
||||
</ul>
|
||||
|
||||
<!--=======================================================================-->
|
||||
<div class="doc_section"><a name="subsystems">LLVM Subsystem Documentation</a></div>
|
||||
<!--=======================================================================-->
|
||||
|
||||
<ul>
|
||||
|
||||
<li><a href="WritingAnLLVMPass.html">Writing an LLVM Pass</a> - Information
|
||||
on how to write LLVM transformations and analyses.</li>
|
||||
|
||||
<li><a href="CodeGenerator.html">The LLVM Target-Independent Code
|
||||
Generator</a> - The design and implementation of the LLVM code generator.
|
||||
Useful if you are working on retargetting LLVM to a new architecture, designing
|
||||
a new codegen pass, or enhancing existing components.</li>
|
||||
|
||||
<li><a href="TableGenFundamentals.html">TableGen Fundamentals</a> -
|
||||
Describes the TableGen tool, which is used heavily by the LLVM code
|
||||
generator.</li>
|
||||
|
||||
<li><a href="AliasAnalysis.html">Alias Analysis in LLVM</a> - Information
|
||||
on how to write a new alias analysis implementation or how to use existing
|
||||
analyses.</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="GarbageCollection.html">Accurate Garbage Collection with
|
||||
LLVM</a> - The interfaces source-language compilers should use for compiling
|
||||
GC'd programs.</li>
|
||||
|
||||
<li><a href="SourceLevelDebugging.html">Source Level Debugging with
|
||||
LLVM</a> - This document describes the design and philosophy behind the LLVM
|
||||
source-level debugger.</li>
|
||||
|
||||
<li><a href="Bugpoint.html">Bugpoint</a> automatic bug finder and
|
||||
test-case reducer description and usage information.</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<!--=======================================================================-->
|
||||
<div class="doc_section"><a name="Support">LLVM Support</a></div>
|
||||
<!--=======================================================================-->
|
||||
|
||||
<ul>
|
||||
<li><a href="FAQ.html">Frequently Asked Questions</a> - A list of common
|
||||
questions and problems and their solutions.</li>
|
||||
|
||||
<li><a href="HowToSubmitABug.html">How-To-Submit-A-Bug</a> - Instructions
|
||||
for the proper way to submit information about a bug you ran into in the LLVM
|
||||
system.</li>
|
||||
|
||||
<li> You can probably find help on the unofficial LLVM IRC channel. We often
|
||||
are on irc.oftc.net in the #llvm channel. If you are using the mozilla
|
||||
browser, and have chatzilla installed, you can join by <a
|
||||
href="irc://irc.oftc.net/llvm">clicking here</a>.</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<!--=======================================================================-->
|
||||
<div class="doc_subsection"><a name="maillist">LLVM Mailing Lists</a></div>
|
||||
<!--=======================================================================-->
|
||||
|
||||
<ul>
|
||||
<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvm-announce">
|
||||
LLVM Announcements List</a>: This is a low volume list that provides important
|
||||
announcements regarding LLVM. It gets email about once a month.</li>
|
||||
|
||||
<li>The <a href="http://mail.cs.uiuc.edu/mailman/listinfo/llvmdev">Developer's
|
||||
List</a>: 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.</li>
|
||||
|
||||
<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvmbugs/">Bugs &
|
||||
Patches Archive</a>: This list gets emailed every time a bug is opened and
|
||||
closed, and when people submit patches to be included in LLVM. It is higher
|
||||
volume than the LLVMdev list.</li>
|
||||
|
||||
<li>The <a href="http://mail.cs.uiuc.edu/pipermail/llvm-commits/">CVS Commits
|
||||
Archive</a>: 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.</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- *********************************************************************** -->
|
||||
|
||||
@ -183,5 +209,3 @@ volume.</p></li>
|
||||
Last modified: $Date$
|
||||
</address>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user