X-Git-Url: http://plrg.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2Findex.html;h=bf12f719b2b6ea7567fd6e3986e54d214fa4d571;hb=8674949513837dab7efa11c8d338db4f714a244b;hp=00b5ee7aca26e1ccd83b47840c88a9031aab8f4b;hpb=5538d83c45522fd811cbef6fa29a52a0ef3eb581;p=oota-llvm.git diff --git a/docs/index.html b/docs/index.html index 00b5ee7aca2..bf12f719b2b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,184 +2,292 @@ "http://www.w3.org/TR/html4/strict.dtd"> - The LLVM Compiler Infrastructure documentation + Documentation for the LLVM System at SVN head -
The LLVM Compiler Infrastructure Documentation
+
Documentation for the LLVM System at SVN head
+ +

If you are using a released version of LLVM, +see the download page to find +your documentation.

+
+ +
+

+ +
+ +

+
+
- -
- Getting Started with LLVM +
+

Written by The LLVM Team

- -
+ +
LLVM Design & Overview
+ + -
- -
Questions & Answers
- + +
LLVM User Guides
+ -
+
  • How to Submit A Bug Report - +Instructions for properly submitting information about any bugs you run into in +the LLVM system.
    • -
    +
  • LLVM Testing Infrastructure Guide - A reference +manual for using the LLVM testing infrastructure.
    • - -
    LLVM Documentation
    - +
  • How to build the Ada/C/C++/Fortran front-ends - +Instructions for building gcc front-ends from source.
    • -
    +
  • Packaging guide - Advice on packaging +LLVM into a distribution.
    • -

    All the documents mentioned below except the design overview tech report -are included as part of the LLVM release (in llvm/docs/*):

    +
  • The LLVM Lexicon - Definition of acronyms, terms +and concepts used in LLVM.
    • -
    +
  • 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 #llvm on irc.oftc.net directly.
    • - -
    LLVM Design Overview
    + -
    -

    LLVM: A -Compilation Framework for Lifelong Program Analysis & Transformation

    -
    - -
    - LLVM User Guides -
    + +
    General LLVM Programming Documentation
    + -
    -
    +
  • LLVM Language Reference Manual - Defines the LLVM +intermediate representation and the assembly form of the different nodes.
    • - -
    LLVM Programming Documentation
    +
  • The LLVM Programmers Manual - +Introduction to the general layout of the LLVM sourcebase, important classes +and APIs, and some tips & tricks.
    • + +
  • LLVM Project Guide - How-to guide and +templates for new projects that use the LLVM infrastructure. The +templates (directory organization, Makefiles, and test tree) allow the project +code to be located outside (or inside) the llvm/ tree, while using LLVM +header files and libraries.
    • + +
  • LLVM Makefile Guide - Describes how the +LLVM makefiles work and how to use them.
    • + +
  • CommandLine library Reference Manual - +Provides information on using the command line parsing library.
    • + +
  • LLVM Coding standards - +Details the LLVM coding standards and provides useful information on writing +efficient C++ code.
    • + +
  • Extending LLVM - Look here to see how +to add instructions and intrinsics to LLVM.
    • + +
  • Using LLVM Libraries - Look here to +understand how to use the libraries produced when LLVM is compiled.
    • + +
  • How To Release LLVM To The Public - This +is a guide to preparing LLVM releases. Most developers can ignore it.
    • + +
  • Doxygen generated +documentation (classes) + +(tarball) +
    • + +
  • ViewVC Repository Browser
    • -
    - -
    - -
    Other LLVM Resources
    + +
    LLVM Subsystem Documentation
    + -
    -
    - -
    Mailing Lists
    - +
  • Writing an LLVM Pass - Information +on how to write LLVM transformations and analyses.
    • -
    +
  • Writing an LLVM Backend - Information +on how to write LLVM backends for machine targets.
    • + +
  • The LLVM Target-Independent Code +Generator - 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.
    • -

    There are three mailing lists for providing LLVM users with information:

    +
  • TableGen Fundamentals - +Describes the TableGen tool, which is used heavily by the LLVM code +generator.
    • -
      +
    1. Alias Analysis in LLVM - Information +on how to write a new alias analysis implementation or how to use existing +analyses.
      2. -
    2. LLVM -Announcements List +
    3. Accurate Garbage Collection with +LLVM - The interfaces source-language compilers should use for compiling +GC'd programs.
      4. -

      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.

      +
    4. Source Level Debugging with +LLVM - This document describes the design and philosophy behind the LLVM +source-level debugger.
      5. -
    5. LLVM Developers -List +
    6. Zero Cost Exception handling in LLVM +- This document describes the design and implementation of exception handling +in LLVM.
      7. -

      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.

      +
    7. Bugpoint - automatic bug finder and test-case +reducer description and usage information.
      8. -
    8. LLVM Commits -List +
    9. Compiler Driver (llvmc) Tutorial +- This document is a tutorial introduction to the usage and +configuration of the LLVM compiler driver tool, llvmc.
      10. -

      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.

      +
    10. Compiler Driver (llvmc) +Reference - This document describes the design and configuration +of llvmc in more detail.
      11. -
    +
  • LLVM Bitcode File Format - This describes +the file format and encoding used for LLVM "bc" files.
    • -
    +
  • System Library - This document describes +the LLVM System Library (lib/System) and how to keep LLVM source code +portable
    • + +
  • Link Time Optimization - This +document describes the interface between LLVM intermodular optimizer and +the linker and its design
    • + +
  • The LLVM gold plugin - How to build your +programs with link-time optimization on Linux.
    • + +
  • The GDB JIT interface - How to debug +JITed code with GDB.
    • + + + + +
    LLVM Mailing Lists
    + + +
    Valid CSS! + src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"> Valid HTML 4.01! + src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"> - John Criswell
    - LLVM Compiler Infrastructure
    + LLVM Compiler Infrastructure
    Last modified: $Date$
    + - -