summaryrefslogtreecommitdiff
path: root/docs/subsystems.rst
diff options
context:
space:
mode:
authorDaniel Dunbar <daniel@zuster.org>2012-04-19 16:31:37 +0000
committerDaniel Dunbar <daniel@zuster.org>2012-04-19 16:31:37 +0000
commit21e993c1b1083ef91441a363997d0efc8e646191 (patch)
tree1c07b2ea2dd18b8219d46415cee365abc93578e2 /docs/subsystems.rst
parent75083ebc09a3dd47099e3912ac090dbc907f3eaf (diff)
downloadllvm-21e993c1b1083ef91441a363997d0efc8e646191.tar.gz
llvm-21e993c1b1083ef91441a363997d0efc8e646191.tar.bz2
llvm-21e993c1b1083ef91441a363997d0efc8e646191.tar.xz
[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 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@155133 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/subsystems.rst')
-rw-r--r--docs/subsystems.rst74
1 files changed, 74 insertions, 0 deletions
diff --git a/docs/subsystems.rst b/docs/subsystems.rst
new file mode 100644
index 0000000000..3a0db7878d
--- /dev/null
+++ b/docs/subsystems.rst
@@ -0,0 +1,74 @@
+.. _subsystems:
+
+Subsystem Documentation
+=======================
+
+ * `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.
+
+ * `TableGen Fundamentals <TableGenFundamentals.html>`_
+
+ Describes the TableGen tool, which is used heavily by the LLVM code
+ generator.
+
+ * `Alias Analysis in LLVM <AliasAnalysis.html>`_
+
+ 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
+
+ * `Link Time Optimization <LinkTimeOptimization.html>`_
+
+ 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.
+
+ * `Branch Weight Metadata <BranchWeightMetadata.html>`_
+
+ Provides information about Branch Prediction Information.