hanchenye-llvm-project/llvm/docs/subsystems.rst

.. _subsystems:

Subsystem Documentation
=======================

.. toctree::
   :hidden:

   AliasAnalysis
   BranchWeightMetadata
   LinkTimeOptimization
   SegmentedStacks
   TableGenFundamentals

* `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.
    
* `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.
    
* :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.

* `Source Level Debugging with LLVM <SourceLevelDebugging.html>`_
    
   This document describes the design and philosophy behind the LLVM
   source-level debugger.
    
* `Zero Cost Exception handling in LLVM <ExceptionHandling.html>`_
    
   This document describes the design and implementation of exception handling
   in LLVM.
    
* `Bugpoint <Bugpoint.html>`_
    
   Automatic bug finder and test-case reducer description and usage
   information.
    
* `LLVM Bitcode File Format <BitCodeFormat.html>`_
    
   This describes the file format and encoding used for LLVM "bc" files.
    
* `System Library <SystemLibrary.html>`_
    
   This document describes the LLVM System Library (<tt>lib/System</tt>) 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
    
* `The LLVM gold plugin <GoldPlugin.html>`_
    
   How to build your programs with link-time optimization on Linux.
    
* `The GDB JIT interface <DebuggingJITedCode.html>`_
    
   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.
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00			`.. _subsystems:`

			`Subsystem Documentation`
			`=======================`

Sphinxify the AliasAnalysis document. llvm-svn: 158805 2012-06-20 17:49:57 +08:00			`.. toctree::`
			`:hidden:`

			`AliasAnalysis`
Sphinxify BranchWeightMetadata document. llvm-svn: 158810 2012-06-20 18:17:46 +08:00			`BranchWeightMetadata`
Sphinxify the LTO document. llvm-svn: 158808 2012-06-20 18:08:02 +08:00			`LinkTimeOptimization`
Sphinxify the SegmentedStack document. llvm-svn: 158819 2012-06-20 20:05:05 +08:00			`SegmentedStacks`
Sphinxify the tablegen document. llvm-svn: 158903 2012-06-21 14:58:24 +08:00			`TableGenFundamentals`
Sphinxify the AliasAnalysis document. llvm-svn: 158805 2012-06-20 17:49:57 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `Writing an LLVM Pass <WritingAnLLVMPass.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`Information on how to write LLVM transformations and analyses.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `Writing an LLVM Backend <WritingAnLLVMBackend.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`Information on how to write LLVM backends for machine targets.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `The LLVM Target-Independent Code Generator <CodeGenerator.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`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.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Sphinxify the tablegen document. llvm-svn: 158903 2012-06-21 14:58:24 +08:00			* :ref:`tablegen`

Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`Describes the TableGen tool, which is used heavily by the LLVM code`
			`generator.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* :ref:`alias_analysis`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`Information on how to write a new alias analysis implementation or how to`
			`use existing analyses.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `Accurate Garbage Collection with LLVM <GarbageCollection.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`The interfaces source-language compilers should use for compiling GC'd`
			`programs.`
Sphinxify the SegmentedStack document. llvm-svn: 158819 2012-06-20 20:05:05 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `Source Level Debugging with LLVM <SourceLevelDebugging.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`This document describes the design and philosophy behind the LLVM`
			`source-level debugger.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `Zero Cost Exception handling in LLVM <ExceptionHandling.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`This document describes the design and implementation of exception handling`
			`in LLVM.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `Bugpoint <Bugpoint.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`Automatic bug finder and test-case reducer description and usage`
			`information.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `LLVM Bitcode File Format <BitCodeFormat.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`This describes the file format and encoding used for LLVM "bc" files.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `System Library <SystemLibrary.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`This document describes the LLVM System Library (<tt>lib/System</tt>) and`
			`how to keep LLVM source code portable`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Sphinxify the LTO document. llvm-svn: 158808 2012-06-20 18:08:02 +08:00			* :ref:`lto`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`This document describes the interface between LLVM intermodular optimizer`
			`and the linker and its design`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `The LLVM gold plugin <GoldPlugin.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`How to build your programs with link-time optimization on Linux.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			* `The GDB JIT interface <DebuggingJITedCode.html>`_
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`How to debug JITed code with GDB.`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Sphinxify BranchWeightMetadata document. llvm-svn: 158810 2012-06-20 18:17:46 +08:00			* :ref:`branch_weight`
[docs] Convert docs index page into Sphinx. - Work in progress, this is mostly important because it lets us incrementally migrate the remaining documentation. - Lots of styling, editing, and integration work yet to come… - PR12589 llvm-svn: 155133 2012-04-20 00:31:37 +08:00
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`Provides information about Branch Prediction Information.`
Sphinxify the SegmentedStack document. llvm-svn: 158819 2012-06-20 20:05:05 +08:00
			* :ref:`segmented_stacks`

			`This document describes segmented stacks and how they are used in LLVM.`