Silence Sphinx warnings.
[oota-llvm.git] / docs / subsystems.rst
index 0a963688407341794930d00ff8605deb6c166c79..8c3cdf2417b8f9e41b5401737382e5f12c44331e 100644 (file)
@@ -7,73 +7,87 @@ Subsystem Documentation
    :hidden:
 
    AliasAnalysis
+   BitCodeFormat
+   BranchWeightMetadata
+   Bugpoint
+   CodeGenerator
+   ExceptionHandling
+   LinkTimeOptimization
+   SegmentedStacks
+   TableGenFundamentals
+   DebuggingJITedCode
+   GoldPlugin
 
- * `Writing an LLVM Pass <WritingAnLLVMPass.html>`_
+* `Writing an LLVM Pass <WritingAnLLVMPass.html>`_
     
-    Information on how to write LLVM transformations and analyses.
+   Information on how to write LLVM transformations and analyses.
     
- * `Writing an LLVM Backend <WritingAnLLVMBackend.html>`_
+* `Writing an LLVM Backend <WritingAnLLVMBackend.html>`_
     
-    Information on how to write LLVM backends for machine targets.
-    
- * `The LLVM Target-Independent Code Generator <CodeGenerator.html>`_
-    
-    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.
-    
- * `TableGen Fundamentals <TableGenFundamentals.html>`_
-    
-    Describes the TableGen tool, which is used heavily by the LLVM code
-    generator.
+   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:`alias_analysis`
+* :ref:`tablegen`
+
+   Describes the TableGen tool, which is used heavily by the LLVM code
+   generator.
     
-    Information on how to write a new alias analysis implementation or how to
-    use existing analyses.
+* :ref:`alias_analysis`
     
- * `Accurate Garbage Collection with LLVM <GarbageCollection.html>`_
+   Information on how to write a new alias analysis implementation or how to
+   use existing analyses.
     
-    The interfaces source-language compilers should use for compiling GC'd
-    programs.
+* `Accurate Garbage Collection with LLVM <GarbageCollection.html>`_
     
- * `Source Level Debugging with LLVM <SourceLevelDebugging.html>`_
+   The interfaces source-language compilers should use for compiling GC'd
+   programs.
+
+* `Source Level Debugging with LLVM <SourceLevelDebugging.html>`_
     
-    This document describes the design and philosophy behind the LLVM
-    source-level debugger.
+   This document describes the design and philosophy behind the LLVM
+   source-level debugger.
     
- * `Zero Cost Exception handling in LLVM <ExceptionHandling.html>`_
+* :ref:`exception_handling`
     
-    This document describes the design and implementation of exception handling
-    in LLVM.
+   This document describes the design and implementation of exception handling
+   in LLVM.
     
- * `Bugpoint <Bugpoint.html>`_
+* :ref:`bugpoint`
     
-    Automatic bug finder and test-case reducer description and usage
-    information.
+   Automatic bug finder and test-case reducer description and usage
+   information.
     
- * `LLVM Bitcode File Format <BitCodeFormat.html>`_
+* :ref:`bitcode_format`
     
-    This describes the file format and encoding used for LLVM "bc" files.
+   This describes the file format and encoding used for LLVM "bc" files.
     
- * `System Library <SystemLibrary.html>`_
+* `System Library <SystemLibrary.html>`_
     
-    This document describes the LLVM System Library (<tt>lib/System</tt>) and
-    how to keep LLVM source code portable
+   This document describes the LLVM System Library (<tt>lib/System</tt>) and
+   how to keep LLVM source code portable
     
- * `Link Time Optimization <LinkTimeOptimization.html>`_
+* :ref:`lto`
     
-    This document describes the interface between LLVM intermodular optimizer
-    and the linker and its design
+   This document describes the interface between LLVM intermodular optimizer
+   and the linker and its design
     
- * `The LLVM gold plugin <GoldPlugin.html>`_
+* :ref:`gold-plugin`
     
-    How to build your programs with link-time optimization on Linux.
+   How to build your programs with link-time optimization on Linux.
     
- * `The GDB JIT interface <DebuggingJITedCode.html>`_
+* :ref:`debugging-jited-code`
     
-    How to debug JITed code with GDB.
+   How to debug JITed code with GDB.
     
- * `Branch Weight Metadata <BranchWeightMetadata.html>`_
+* :ref:`branch_weight`
     
-    Provides information about Branch Prediction Information.
+   Provides information about Branch Prediction Information.
+
+* :ref:`segmented_stacks`
+
+   This document describes segmented stacks and how they are used in LLVM.