:hidden:
LangRef
- GetElementPtr
-
-* :doc:`LangRef`
+:doc:`LangRef`
Defines the LLVM intermediate representation.
-* `Introduction to the LLVM Compiler <http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html>`_
-
+`Introduction to the LLVM Compiler`__
Presentation providing a users introduction to LLVM.
-* `Intro to LLVM <http://www.aosabook.org/en/llvm.html>`_
+ .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
+`Intro to LLVM`__
Book chapter providing a compiler hacker's introduction to LLVM.
-* `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation
- <http://llvm.org/pubs/2004-01-30-CGO-LLVM.html>`_
+ .. __: http://www.aosabook.org/en/llvm.html
+
+`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
Design overview.
-* `LLVM: An Infrastructure for Multi-Stage Optimization
- <http://llvm.org/pubs/2002-12-LattnerMSThesis.html>`_
+ .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
+`LLVM: An Infrastructure for Multi-Stage Optimization`__
More details (quite old now).
-* :doc:`GetElementPtr`
-
- Answers to some very frequent questions about LLVM's most frequently
- misunderstood instruction.
+ .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
-Publications
-============
-
-The list of `publications <http://llvm.org/pubs>`_ based on LLVM.
+`Publications mentioning LLVM <http://llvm.org/pubs>`_
+ ..
User Guides
===========
CMake
HowToBuildOnARM
+ HowToCrossCompileLLVM
CommandGuide/index
- DeveloperPolicy
GettingStarted
GettingStartedVS
FAQ
Lexicon
- Packaging
HowToAddABuilder
yaml2obj
HowToSubmitABug
ReleaseNotes
Passes
YamlIO
+ GetElementPtr
+ MCJITDesignAndImplementation
-* :doc:`GettingStarted`
-
+:doc:`GettingStarted`
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.
-* :doc:`CMake`
-
+:doc:`CMake`
An addendum to the main Getting Started guide for those using the `CMake
build system <http://www.cmake.org>`_.
-* :doc:`HowToBuildOnARM`
-
+:doc:`HowToBuildOnARM`
Notes on building and testing LLVM/Clang on ARM.
-* :doc:`GettingStartedVS`
+:doc:`HowToCrossCompileLLVM`
+ Notes on cross-building and testing LLVM/Clang.
+:doc:`GettingStartedVS`
An addendum to the main Getting Started guide for those using Visual Studio
on Windows.
-* :doc:`tutorial/index`
-
+:doc:`tutorial/index`
Tutorials about using LLVM. Includes a tutorial about making a custom
language with LLVM.
-* :doc:`DeveloperPolicy`
-
- The LLVM project's policy towards developers and their contributions.
-
-* :doc:`LLVM Command Guide <CommandGuide/index>`
-
+:doc:`LLVM Command Guide <CommandGuide/index>`
A reference manual for the LLVM command line utilities ("man" pages for LLVM
tools).
-* :doc:`Passes`
-
+:doc:`Passes`
A list of optimizations and analyses implemented in LLVM.
-* :doc:`FAQ`
-
+:doc:`FAQ`
A list of common questions and problems and their solutions.
-* :doc:`Release notes for the current release <ReleaseNotes>`
-
+:doc:`Release notes for the current release <ReleaseNotes>`
This describes new features, known bugs, and other limitations.
-* :doc:`HowToSubmitABug`
-
+:doc:`HowToSubmitABug`
Instructions for properly submitting information about any bugs you run into
in the LLVM system.
-* :doc:`SphinxQuickstartTemplate`
+:doc:`SphinxQuickstartTemplate`
A template + tutorial for writing new Sphinx documentation. It is meant
to be read in source form.
-* :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
-
+:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
A reference manual for using the LLVM testing infrastructure.
-* `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_
-
+`How to build the C, C++, ObjC, and ObjC++ front end`__
Instructions for building the clang front-end from source.
-* :doc:`Packaging`
-
- Advice on packaging LLVM into a distribution.
-
-* :doc:`Lexicon`
+ .. __: http://clang.llvm.org/get_started.html
+:doc:`Lexicon`
Definition of acronyms, terms and concepts used in LLVM.
-* :doc:`HowToAddABuilder`
-
+:doc:`HowToAddABuilder`
Instructions for adding new builder to LLVM buildbot master.
-* :doc:`YamlIO`
-
+:doc:`YamlIO`
A reference guide for using LLVM's YAML I/O library.
-IRC
-===
-
-You can probably find help on the unofficial LLVM IRC.
-
-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 <irc://irc.oftc.net/llvm>`_.
+:doc:`GetElementPtr`
+ Answers to some very frequent questions about LLVM's most frequently
+ misunderstood instruction.
Programming Documentation
=========================
ExtendingLLVM
HowToSetUpLLVMStyleRTTI
ProgrammersManual
+ Extensions
-* :doc:`LLVM Language Reference Manual <LangRef>`
-
+:doc:`LLVM Language Reference Manual <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
-* :doc:`Atomics`
-
+:doc:`Atomics`
Information about LLVM's concurrency model.
-* :doc:`ProgrammersManual`
-
+:doc:`ProgrammersManual`
Introduction to the general layout of the LLVM sourcebase, important classes
and APIs, and some tips & tricks.
-* :doc:`CommandLine`
+:doc:`Extensions`
+ LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
+:doc:`CommandLine`
Provides information on using the command line parsing library.
-* :doc:`CodingStandards`
-
+:doc:`CodingStandards`
Details the LLVM coding standards and provides useful information on writing
efficient C++ code.
-* :doc:`HowToSetUpLLVMStyleRTTI`
-
+:doc:`HowToSetUpLLVMStyleRTTI`
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
-* :doc:`ExtendingLLVM`
-
+:doc:`ExtendingLLVM`
Look here to see how to add instructions and intrinsics to LLVM.
-* `Doxygen generated documentation <http://llvm.org/doxygen/>`_
-
+`Doxygen generated documentation <http://llvm.org/doxygen/>`_
(`classes <http://llvm.org/doxygen/inherits.html>`_)
(`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
-* `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
-
-* :doc:`CompilerWriterInfo`
+`ViewVC Repository Browser <http://llvm.org/viewvc/>`_
+ ..
+:doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.
Subsystem Documentation
AliasAnalysis
BitCodeFormat
+ BlockFrequencyTerminology
BranchWeightMetadata
Bugpoint
CodeGenerator
LinkTimeOptimization
SegmentedStacks
TableGenFundamentals
+ TableGen/index
DebuggingJITedCode
GoldPlugin
MarkedUpDisassembly
WritingAnLLVMBackend
GarbageCollection
WritingAnLLVMPass
- TableGen/LangRef
-
-* :doc:`WritingAnLLVMPass`
-
+ HowToUseAttributes
+ NVPTXUsage
+ StackMaps
+ InAlloca
+ BigEndianNEON
+ CoverageMappingFormat
+
+:doc:`WritingAnLLVMPass`
Information on how to write LLVM transformations and analyses.
-* :doc:`WritingAnLLVMBackend`
-
+:doc:`WritingAnLLVMBackend`
Information on how to write LLVM backends for machine targets.
-* :doc:`CodeGenerator`
-
+:doc:`CodeGenerator`
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.
-* :doc:`TableGenFundamentals`
-
+:doc:`TableGen <TableGen/index>`
Describes the TableGen tool, which is used heavily by the LLVM code
generator.
-* :doc:`AliasAnalysis`
-
+:doc:`AliasAnalysis`
Information on how to write a new alias analysis implementation or how to
use existing analyses.
-* :doc:`GarbageCollection`
-
+:doc:`GarbageCollection`
The interfaces source-language compilers should use for compiling GC'd
programs.
-* :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
-
+:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
This document describes the design and philosophy behind the LLVM
source-level debugger.
-* :doc:`Vectorizers`
-
+:doc:`Vectorizers`
This document describes the current status of vectorization in LLVM.
-* :doc:`ExceptionHandling`
-
+:doc:`ExceptionHandling`
This document describes the design and implementation of exception handling
in LLVM.
-* :doc:`Bugpoint`
-
+:doc:`Bugpoint`
Automatic bug finder and test-case reducer description and usage
information.
-* :doc:`BitCodeFormat`
-
+:doc:`BitCodeFormat`
This describes the file format and encoding used for LLVM "bc" files.
-* :doc:`System Library <SystemLibrary>`
-
+:doc:`System Library <SystemLibrary>`
This document describes the LLVM System Library (``lib/System``) and
how to keep LLVM source code portable
-* :doc:`LinkTimeOptimization`
-
+:doc:`LinkTimeOptimization`
This document describes the interface between LLVM intermodular optimizer
and the linker and its design
-* :doc:`GoldPlugin`
-
+:doc:`GoldPlugin`
How to build your programs with link-time optimization on Linux.
-* :doc:`DebuggingJITedCode`
-
+:doc:`DebuggingJITedCode`
How to debug JITed code with GDB.
-* :doc:`BranchWeightMetadata`
+:doc:`MCJITDesignAndImplementation`
+ Describes the inner workings of MCJIT execution engine.
+:doc:`BranchWeightMetadata`
Provides information about Branch Prediction Information.
-* :doc:`SegmentedStacks`
+:doc:`BlockFrequencyTerminology`
+ Provides information about terminology used in the ``BlockFrequencyInfo``
+ analysis pass.
+:doc:`SegmentedStacks`
This document describes segmented stacks and how they are used in LLVM.
-* :doc:`MarkedUpDisassembly`
-
+:doc:`MarkedUpDisassembly`
This document describes the optional rich disassembly output syntax.
+:doc:`HowToUseAttributes`
+ Answers some questions about the new Attributes infrastructure.
+
+:doc:`NVPTXUsage`
+ This document describes using the NVPTX back-end to compile GPU kernels.
+
+:doc:`StackMaps`
+ LLVM support for mapping instruction addresses to the location of
+ values and allowing code to be patched.
+
+:doc:`BigEndianNEON`
+ LLVM's support for generating NEON instructions on big endian ARM targets is
+ somewhat nonintuitive. This document explains the implementation and rationale.
+
+:doc:`CoverageMappingFormat`
+ This describes the format and encoding used for LLVM’s code coverage mapping.
Development Process Documentation
=================================
-
Information about LLVM's development process.
.. toctree::
:hidden:
+ DeveloperPolicy
MakefileGuide
Projects
LLVMBuild
HowToReleaseLLVM
+ Packaging
+ ReleaseProcess
+ Phabricator
-* :doc:`Projects`
+:doc:`DeveloperPolicy`
+ The LLVM project's policy towards developers and their contributions.
+:doc:`Projects`
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.
-* :doc:`LLVMBuild`
-
+:doc:`LLVMBuild`
Describes the LLVMBuild organization and files used by LLVM to specify
component descriptions.
-* :doc:`MakefileGuide`
-
+:doc:`MakefileGuide`
Describes how the LLVM makefiles work and how to use them.
-* :doc:`HowToReleaseLLVM`
-
+:doc:`HowToReleaseLLVM`
This is a guide to preparing LLVM releases. Most developers can ignore it.
-Mailing Lists
-=============
+:doc:`ReleaseProcess`
+ This is a guide to validate a new release, during the release process. Most developers can ignore it.
-If you can't find what you need in these docs, try consulting the mailing
-lists.
+:doc:`Packaging`
+ Advice on packaging LLVM into a distribution.
-* `LLVM Announcements List
- <http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce>`_
+:doc:`Phabricator`
+ Describes how to use the Phabricator code review tool hosted on
+ http://reviews.llvm.org/ and its command line interface, Arcanist.
- This is a low volume list that provides important announcements regarding
- LLVM. It gets email about once a month.
+Community
+=========
+
+LLVM has a thriving community of friendly and helpful developers.
+The two primary communication mechanisms in the LLVM community are mailing
+lists and IRC.
+
+Mailing Lists
+-------------
-* `Developer's List <http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev>`_
+If you can't find what you need in these docs, try consulting the mailing
+lists.
+`Developer's List (llvmdev)`__
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.
-* `Bugs & Patches Archive <http://lists.cs.uiuc.edu/pipermail/llvmbugs/>`_
+ .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
- 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.
+`Commits Archive (llvm-commits)`__
+ This list contains all commit messages that are made when LLVM developers
+ commit code changes to the repository. It also serves as a forum for
+ patch review (i.e. send patches here). It is useful for those who want to
+ stay on the bleeding edge of LLVM development. This list is very high
+ volume.
-* `Commits Archive <http://lists.cs.uiuc.edu/pipermail/llvm-commits/>`_
+ .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
- This list contains all commit messages that are made when LLVM developers
- commit code changes to the repository. It is useful for those who want to
- stay on the bleeding edge of LLVM development. This list is very high volume.
+`Bugs & Patches Archive (llvmbugs)`__
+ This list gets emailed every time a bug is opened and closed. It is
+ higher volume than the LLVMdev list.
-* `Test Results Archive
- <http://lists.cs.uiuc.edu/pipermail/llvm-testresults/>`_
+ .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
+`Test Results Archive (llvm-testresults)`__
A message is automatically sent to this list by every active nightly tester
when it completes. As such, this list gets email several times each day,
making it a high volume list.
+ .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
+
+`LLVM Announcements List (llvm-announce)`__
+ This is a low volume list that provides important announcements regarding
+ LLVM. It gets email about once a month.
+
+ .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
+
+IRC
+---
+
+Users and developers of the LLVM project (including subprojects such as Clang)
+can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
+
+This channel has several bots.
+
+* Buildbot reporters
+
+ * llvmbb - Bot for the main LLVM buildbot master.
+ http://lab.llvm.org:8011/console
+ * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
+ * smooshlab - Apple's internal buildbot master.
+
+* robot - Bugzilla linker. %bug <number>
+
+* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
+ near-trunk clang instead of gcc.
+
+
Indices and tables
==================
projects / oota-llvm.git / blobdiff