docs/subsystems.rst

   1 .. _subsystems:
   2
   3 Subsystem Documentation
   4 =======================
   5
   6 .. toctree::
   7    :hidden:
   8
   9    AliasAnalysis
  10    BitCodeFormat
  11    BranchWeightMetadata
  12    Bugpoint
  13    CodeGenerator
  14    ExceptionHandling
  15    LinkTimeOptimization
  16    SegmentedStacks
  17    TableGenFundamentals
  18    DebuggingJITedCode
  19    GoldPlugin
  20    MarkedUpDisassembly
  21    SystemLibrary
  22    SourceLevelDebugging
  23    Vectorizers
  24    WritingAnLLVMBackend
  25    GarbageCollection
  26    WritingAnLLVMPass
  27    TableGen/LangRef
  28
  29 * :doc:`WritingAnLLVMPass`
  30
  31    Information on how to write LLVM transformations and analyses.
  32
  33 * :doc:`WritingAnLLVMBackend`
  34
  35    Information on how to write LLVM backends for machine targets.
  36
  37 * :ref:`code_generator`
  38
  39    The design and implementation of the LLVM code generator.  Useful if you are
  40    working on retargetting LLVM to a new architecture, designing a new codegen
  41    pass, or enhancing existing components.
  42
  43 * :ref:`tablegen`
  44
  45    Describes the TableGen tool, which is used heavily by the LLVM code
  46    generator.
  47
  48 * :ref:`alias_analysis`
  49
  50    Information on how to write a new alias analysis implementation or how to
  51    use existing analyses.
  52
  53 * :doc:`GarbageCollection`
  54
  55    The interfaces source-language compilers should use for compiling GC'd
  56    programs.
  57
  58 * :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
  59
  60    This document describes the design and philosophy behind the LLVM
  61    source-level debugger.
  62
  63 * :doc:`Vectorizers`
  64
  65    This document describes the current status of vectorization in LLVM.
  66
  67 * :ref:`exception_handling`
  68
  69    This document describes the design and implementation of exception handling
  70    in LLVM.
  71
  72 * :ref:`bugpoint`
  73
  74    Automatic bug finder and test-case reducer description and usage
  75    information.
  76
  77 * :ref:`bitcode_format`
  78
  79    This describes the file format and encoding used for LLVM "bc" files.
  80
  81 * :doc:`System Library <SystemLibrary>`
  82
  83    This document describes the LLVM System Library (``lib/System``) and
  84    how to keep LLVM source code portable
  85
  86 * :ref:`lto`
  87
  88    This document describes the interface between LLVM intermodular optimizer
  89    and the linker and its design
  90
  91 * :ref:`gold-plugin`
  92
  93    How to build your programs with link-time optimization on Linux.
  94
  95 * :ref:`debugging-jited-code`
  96
  97    How to debug JITed code with GDB.
  98
  99 * :ref:`branch_weight`
 100
 101    Provides information about Branch Prediction Information.
 102
 103 * :ref:`segmented_stacks`
 104
 105    This document describes segmented stacks and how they are used in LLVM.
 106
 107 * :ref:`marked_up_disassembly`
 108
 109    This document describes the optional rich disassembly output syntax.
 110