llvm-project/llvm/docs/subsystems.rst

.. _subsystems:

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

.. toctree::
   :hidden:

   AliasAnalysis
   BitCodeFormat
   BranchWeightMetadata
   Bugpoint
   CodeGenerator
   ExceptionHandling
   LinkTimeOptimization
   SegmentedStacks
   TableGenFundamentals
   DebuggingJITedCode
   GoldPlugin
   MarkedUpDisassembly
   HowToUseInstrMappings
   SystemLibrary

.. 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.

* `Source Level Debugging with LLVM <SourceLevelDebugging.html>`_
    
   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.
[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 the bitcode format document. llvm-svn: 159340 2012-06-28 16:43:12 +08:00			`BitCodeFormat`
Sphinxify BranchWeightMetadata document. llvm-svn: 158810 2012-06-20 18:17:46 +08:00			`BranchWeightMetadata`
Sphyinxify the Bugpoint document. llvm-svn: 159199 2012-06-26 19:37:00 +08:00			`Bugpoint`
Sphinxify the Code Generator document. llvm-svn: 161164 2012-08-02 16:49:53 +08:00			`CodeGenerator`
Sphinxify the exception handling doc. llvm-svn: 159254 2012-06-27 15:20:57 +08:00			`ExceptionHandling`
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`
Fix Sphinx warnings. Toctree was not being interlinked properly. llvm-svn: 164282 2012-09-20 11:20:53 +08:00			`DebuggingJITedCode`
docs: Sphinxify GoldPlugin document. llvm-svn: 165198 2012-10-04 11:56:23 +08:00			`GoldPlugin`
Add a bit of documentation on the annotated disassembly output. llvm-svn: 166639 2012-10-25 07:30:22 +08:00			`MarkedUpDisassembly`
docs: Fix Sphinx toctree warning. llvm-svn: 167905 2012-11-14 09:49:23 +08:00			`HowToUseInstrMappings`
Documentation: convert SystemLibrary documentation to reST llvm-svn: 168289 2012-11-19 02:40:21 +08:00			`SystemLibrary`
docs: Fix Sphinx toctree warning. llvm-svn: 167905 2012-11-14 09:49:23 +08:00
			`.. FIXME: once LangRef is Sphinxified, HowToUseInstrMappings should be put`
			`under LangRef's toctree instead of this page's toctree.`
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.`
Sphinxify the Code Generator document. llvm-svn: 161164 2012-08-02 16:49:53 +08:00
			* :ref:`code_generator`

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
Sphinxify the exception handling doc. llvm-svn: 159254 2012-06-27 15:20:57 +08:00			* :ref:`exception_handling`
[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
Sphyinxify the Bugpoint document. llvm-svn: 159199 2012-06-26 19:37:00 +08:00			* :ref:`bugpoint`
[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
Sphinxify the bitcode format document. llvm-svn: 159340 2012-06-28 16:43:12 +08:00			* :ref:`bitcode_format`
[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
Documentation: convert SystemLibrary documentation to reST llvm-svn: 168289 2012-11-19 02:40:21 +08:00			* :doc:`System Library <SystemLibrary>`
[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
Documentation: convert SystemLibrary documentation to reST llvm-svn: 168289 2012-11-19 02:40:21 +08:00			This document describes the LLVM System Library (``lib/System``) and
Unindent list. llvm-svn: 158806 2012-06-20 17:50:45 +08:00			`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
docs: Sphinxify GoldPlugin document. llvm-svn: 165198 2012-10-04 11:56:23 +08:00			* :ref:`gold-plugin`
[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
Fix Sphinx warnings. Toctree was not being interlinked properly. llvm-svn: 164282 2012-09-20 11:20:53 +08:00			* :ref:`debugging-jited-code`
[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.`
docs: Add link to integrated assembler HowTo llvm-svn: 166106 2012-10-18 00:36:27 +08:00
			* `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
Add a bit of documentation on the annotated disassembly output. llvm-svn: 166639 2012-10-25 07:30:22 +08:00
			* :ref:`marked_up_disassembly`

			`This document describes the optional rich disassembly output syntax.`