llvm-6502/docs/subsystems.rst
2012-11-22 11:56:02 +00:00

113 lines
2.9 KiB
ReStructuredText

.. _subsystems:
Subsystem Documentation
=======================
.. toctree::
:hidden:
AliasAnalysis
BitCodeFormat
BranchWeightMetadata
Bugpoint
CodeGenerator
ExceptionHandling
LinkTimeOptimization
SegmentedStacks
TableGenFundamentals
DebuggingJITedCode
GoldPlugin
MarkedUpDisassembly
HowToUseInstrMappings
SystemLibrary
SourceLevelDebugging
.. FIXME: once LangRef is Sphinxified, HowToUseInstrMappings should be put
under LangRef's toctree instead of this page's toctree.
* `Writing an LLVM Pass <WritingAnLLVMPass.html>`_
Information on how to write LLVM transformations and analyses.
* `Writing an LLVM Backend <WritingAnLLVMBackend.html>`_
Information on how to write LLVM backends for machine targets.
* :ref:`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.
* :ref:`tablegen`
Describes the TableGen tool, which is used heavily by the LLVM code
generator.
* :ref:`alias_analysis`
Information on how to write a new alias analysis implementation or how to
use existing analyses.
* `Accurate Garbage Collection with LLVM <GarbageCollection.html>`_
The interfaces source-language compilers should use for compiling GC'd
programs.
* :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
This document describes the design and philosophy behind the LLVM
source-level debugger.
* :ref:`exception_handling`
This document describes the design and implementation of exception handling
in LLVM.
* :ref:`bugpoint`
Automatic bug finder and test-case reducer description and usage
information.
* :ref:`bitcode_format`
This describes the file format and encoding used for LLVM "bc" files.
* :doc:`System Library <SystemLibrary>`
This document describes the LLVM System Library (``lib/System``) and
how to keep LLVM source code portable
* :ref:`lto`
This document describes the interface between LLVM intermodular optimizer
and the linker and its design
* :ref:`gold-plugin`
How to build your programs with link-time optimization on Linux.
* :ref:`debugging-jited-code`
How to debug JITed code with GDB.
* :ref:`branch_weight`
Provides information about Branch Prediction Information.
* :ref:`segmented_stacks`
This document describes segmented stacks and how they are used in LLVM.
* `Howto: Implementing LLVM Integrated Assembler`_
A simple guide for how to implement an LLVM integrated assembler for an
architecture.
.. _`Howto: Implementing LLVM Integrated Assembler`: http://www.embecosm.com/download/ean10.html
* :ref:`marked_up_disassembly`
This document describes the optional rich disassembly output syntax.