Sphinxify the lexicon doc.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@158813 91177308-0d34-0410-b5e6-96231b3b80d8
author: Bill Wendling <isanbard@gmail.com> 2012-06-20 10:36:41 +0000
committer: Bill Wendling <isanbard@gmail.com> 2012-06-20 10:36:41 +0000
commit: 5cda9016477b206d1d75b0e3a83ff1597a1f8d12 (patch)
tree: d7852011190e2dc5f06db21f41c4ee5e3366e5d0 /docs
parent: 707f2fd26bd36e384b5d78d61a21ee45711768ef (diff)
download: external_llvm-5cda9016477b206d1d75b0e3a83ff1597a1f8d12.zip
external_llvm-5cda9016477b206d1d75b0e3a83ff1597a1f8d12.tar.gz
external_llvm-5cda9016477b206d1d75b0e3a83ff1597a1f8d12.tar.bz2
3 files changed, 196 insertions, 295 deletions
diff --git a/docs/Lexicon.html b/docs/Lexicon.html
deleted file mode 100644
index 60d9016..0000000
--- a/docs/Lexicon.html
+++ /dev/null
@@ -1,294 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
-<html>
-<head>
-  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
-  <title>The LLVM Lexicon</title>
-  <link rel="stylesheet" href="_static/llvm.css" type="text/css">
-  <meta name="author" content="Various">
-  <meta name="description" 
-  content="A glossary of terms used with the LLVM project.">
-</head>
-<body>
-<h1>The LLVM Lexicon</h1>
-<p class="doc_warning">NOTE: This document is a work in progress!</p>
-<!-- *********************************************************************** -->
-<h2>Table Of Contents</h2>
-<!-- *********************************************************************** -->
-<div>
-  <table>
-    <tr><th colspan="8"><b>- <a href="#A">A</a> -</b></th></tr>
-    <tr>
-      <td><a href="#ADCE">ADCE</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#B">B</a> -</b></th></tr>
-    <tr>
-      <td><a href="#BURS">BURS</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#C">C</a> -</b></th></tr>
-    <tr>
-      <td><a href="#CSE">CSE</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#D">D</a> -</b></th></tr>
-    <tr>
-      <td><a href="#DAG">DAG</a></td>
-      <td><a href="#Derived_Pointer">Derived Pointer</a></td>
-      <td><a href="#DSA">DSA</a></td>
-      <td><a href="#DSE">DSE</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#F">F</a> -</b></th></tr>
-    <tr>
-      <td><a href="#FCA">FCA</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#G">G</a> -</b></th></tr>
-    <tr>
-      <td><a href="#GC">GC</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#I">I</a> -</b></th></tr>
-    <tr>
-      <td><a href="#IPA">IPA</a></td>
-      <td><a href="#IPO">IPO</a></td>
-      <td><a href="#ISel">ISel</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#L">L</a> -</b></th></tr>
-    <tr>
-      <td><a href="#LCSSA">LCSSA</a></td>
-      <td><a href="#LICM">LICM</a></td>
-      <td><a href="#Load-VN">Load-VN</a></td>
-      <td><a href="#LTO">LTO</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#M">M</a> -</b></th></tr>
-    <tr>
-      <td><a href="#MC">MC</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#O">O</a> -</b></th></tr>
-    <tr>
-      <td><a href="#Object_Pointer">Object Pointer</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#P">P</a> -</b></th></tr>
-    <tr>
-      <td><a href="#PRE">PRE</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#R">R</a> -</b></th></tr>
-    <tr>
-      <td><a href="#RAUW">RAUW</a></td>
-      <td><a href="#Reassociation">Reassociation</a></td>
-      <td><a href="#Root">Root</a></td>
-      <td><a href="#RPO">RPO</a></td>
-    </tr>
-    <tr><th colspan="8"><b>- <a href="#S">S</a> -</b></th></tr>
-    <tr>
-      <td><a href="#Safe_Point">Safe Point</a></td>
-      <td><a href="#SCC">SCC</a></td>
-      <td><a href="#SCCP">SCCP</a></td>
-      <td><a href="#SDISel">SDISel</a></td>
-      <td><a href="#SRoA">SRoA</a></td>
-      <td><a href="#Stack_Map">Stack Map</a></td>
-    </tr>
-  </table>
-</div>
-
-<!-- *********************************************************************** -->
-<h2>Definitions</h2>
-<!-- *********************************************************************** -->
-<div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="A">- A -</a></h3>
-<div>
-  <dl>
-    <dt><a name="ADCE"><b>ADCE</b></a></dt>
-    <dd>Aggressive Dead Code Elimination</dd>
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="B">- B -</a></h3>
-<div>
-  <dl>
-    <dt><a name="BURS"><b>BURS</b></a></dt>
-    <dd>Bottom Up Rewriting System&mdash;A method of instruction selection for
-        code generation.  An example is the <a 
-href="http://www.program-transformation.org/Transform/BURG">BURG</a> tool.</dd>
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="C">- C -</a></h3>
-<div>
-  <dl>
-    <dt><a name="CSE"><b>CSE</b></a></dt>
-    <dd>Common Subexpression Elimination. An optimization that removes common
-    subexpression compuation. For example <tt>(a+b)*(a+b)</tt> has two
-    subexpressions that are the same: <tt>(a+b)</tt>. This optimization would
-    perform the addition only once and then perform the multiply (but only if
-    it's compulationally correct/safe).
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="D">- D -</a></h3>
-<div>
-  <dl>
-    <dt><a name="DAG"><b>DAG</b></a></dt>
-    <dd>Directed Acyclic Graph</dd>
-    <dt><a name="Derived_Pointer"><b>Derived Pointer</b></a></dt>
-    <dd>A pointer to the interior of an object, such that a garbage collector
-    is unable to use the pointer for reachability analysis. While a derived
-    pointer is live, the corresponding object pointer must be kept in a root,
-    otherwise the collector might free the referenced object. With copying
-    collectors, derived pointers pose an additional hazard that they may be
-    invalidated at any <a href="Safe_Point">safe point</a>. This term is used in
-    opposition to <a href="#Object_Pointer">object pointer</a>.</dd>
-    <dt><a name="DSA"><b>DSA</b></a></dt>
-    <dd>Data Structure Analysis</dd>
-    <dt><a name="DSE"><b>DSE</b></a></dt>
-    <dd>Dead Store Elimination</dd>
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="F">- F -</a></h3>
-<div>
-  <dl>
-    <dt><a name="FCA"><b>FCA</b></a></dt>
-    <dd>First Class Aggregate</dd>
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="G">- G -</a></h3>
-<div>
-  <dl>
-    <dt><a name="GC"><b>GC</b></a></dt>
-    <dd>Garbage Collection. The practice of using reachability analysis instead
-    of explicit memory management to reclaim unused memory.</dd>
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="H">- H -</a></h3>
-<div>
-  <dl>
-    <dt><a name="Heap"><b>Heap</b></a></dt>
-    <dd>In garbage collection, the region of memory which is managed using
-    reachability analysis.</dd>
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="I">- I -</a></h3>
-<div>
-  <dl>
-    <dt><a name="IPA"><b>IPA</b></a></dt>
-    <dd>Inter-Procedural Analysis. Refers to any variety of code analysis that
-    occurs between procedures, functions or compilation units (modules).</dd>
-    <dt><a name="IPO"><b>IPO</b></a></dt>
-    <dd>Inter-Procedural Optimization. Refers to any variety of code
-    optimization that occurs between procedures, functions or compilation units
-    (modules).</dd>
-    <dt><a name="ISel"><b>ISel</b></a></dt>
-    <dd>Instruction Selection.</dd>
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="L">- L -</a></h3>
-<div>
-  <dl>
-    <dt><a name="LCSSA"><b>LCSSA</b></a></dt>
-    <dd>Loop-Closed Static Single Assignment Form</dd>
-    <dt><a name="LICM"><b>LICM</b></a></dt>
-    <dd>Loop Invariant Code Motion</dd>
-    <dt><a name="Load-VN"><b>Load-VN</b></a></dt>
-    <dd>Load Value Numbering</dd>
-    <dt><a name="LTO"><b>LTO</b></a></dt>
-    <dd>Link-Time Optimization</dd>
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="M">- M -</a></h3>
-<div>
-  <dl>
-    <dt><a name="MC"><b>MC</b></a></dt>
-    <dd>Machine Code</dd>
-  </dl>
-</div>
-<!-- _______________________________________________________________________ -->
-<h3><a name="O">- O -</a></h3>
-<div>
-  <dl>
-    <dt><a name="Object_Pointer"><b>Object Pointer</b></a></dt>
-    <dd>A pointer to an object such that the garbage collector is able to trace
-    references contained within the object. This term is used in opposition to
-    <a href="#Derived_Pointer">derived pointer</a>.</dd>
-  </dl>
-</div>
-
-<!-- _______________________________________________________________________ -->
-<h3><a name="P">- P -</a></h3>
-<div>
-  <dl>
-    <dt><a name="PRE"><b>PRE</b></a></dt>
-    <dd>Partial Redundancy Elimination</dd>
-  </dl>
-</div>
-
-<!-- _______________________________________________________________________ -->
-<h3><a name="R">- R -</a></h3>
-<div>
-  <dl>
-  	<dt><a name="RAUW"><b>RAUW</b></a></dt> <dd>An abbreviation for Replace
-  	All Uses With. The functions User::replaceUsesOfWith(), 
-  	Value::replaceAllUsesWith(), and Constant::replaceUsesOfWithOnConstant()
-  	implement the replacement of one Value with another by iterating over its
-  	def/use chain and fixing up all of the pointers to point to the new value.
-  	See also <a href="ProgrammersManual.html#iterate_chains">def/use chains</a>.
-  	</dd>
-    <dt><a name="Reassociation"><b>Reassociation</b></a></dt> <dd>Rearranging
-    associative expressions to promote better redundancy elimination and other
-    optimization.  For example, changing (A+B-A) into (B+A-A), permitting it to
-    be optimized into (B+0) then (B).</dd>
-    <dt><a name="Root"><b>Root</b></a></dt> <dd>In garbage collection, a
-    pointer variable lying outside of the <a href="#Heap">heap</a> from which
-    the collector begins its reachability analysis. In the context of code
-    generation, "root" almost always refers to a "stack root" -- a local or
-    temporary variable within an executing function.</dd>
-    <dt><a name="RPO"><b>RPO</b></a></dt> <dd>Reverse postorder</dd>
-  </dl>
-</div>
-
-<!-- _______________________________________________________________________ -->
-<h3><a name="S">- S -</a></h3>
-<div>
-  <dl>
-    <dt><a name="Safe_Point"><b>Safe Point</b></a></dt>
-    <dd>In garbage collection, it is necessary to identify <a href="#Root">stack
-    roots</a> so that reachability analysis may proceed. It may be infeasible to
-    provide this information for every instruction, so instead the information
-    may is calculated only at designated safe points. With a copying collector,
-    <a href="#Derived_Pointers">derived pointers</a> must not be retained across
-    safe points and <a href="#Object_Pointers">object pointers</a> must be
-    reloaded from stack roots.</dd>
-    <dt><a name="SDISel"><b>SDISel</b></a></dt>
-    <dd>Selection DAG Instruction Selection.</dd>
-    <dt><a name="SCC"><b>SCC</b></a></dt>
-    <dd>Strongly Connected Component</dd>
-    <dt><a name="SCCP"><b>SCCP</b></a></dt>
-    <dd>Sparse Conditional Constant Propagation</dd>
-    <dt><a name="SRoA"><b>SRoA</b></a></dt>
-    <dd>Scalar Replacement of Aggregates</dd>
-    <dt><a name="SSA"><b>SSA</b></a></dt>
-    <dd>Static Single Assignment</dd>
-    <dt><a name="Stack_Map"><b>Stack Map</b></a></dt>
-    <dd>In garbage collection, metadata emitted by the code generator which
-    identifies <a href="#Root">roots</a> within the stack frame of an executing
-    function.</dd>
-  </dl>
-</div>
-
-</div>  
-<!-- *********************************************************************** -->
-<hr>
-<address> <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
- src="http://jigsaw.w3.org/css-validator/images/vcss-blue" alt="Valid CSS"></a><a
- href="http://validator.w3.org/check/referer"><img
- src="http://www.w3.org/Icons/valid-html401-blue" alt="Valid HTML 4.01"></a><a
- href="http://llvm.org/">The LLVM Team</a><br>
-<a href="http://llvm.org/">The LLVM Compiler Infrastructure</a><br>
-Last modified: $Date$
-</address>
-<!-- vim: sw=2
--->
-</body>
-</html>
diff --git a/docs/Lexicon.rst b/docs/Lexicon.rst
new file mode 100644
index 0000000..6ebe614
--- /dev/null
+++ b/docs/Lexicon.rst
@@ -0,0 +1,194 @@
+.. _lexicon:
+
+================
+The LLVM Lexicon
+================
+
+.. note::
+
+    This document is a work in progress!
+
+Definitions
+===========
+
+A
+-
+
+**ADCE**
+    Aggressive Dead Code Elimination
+
+B
+-
+
+**BURS**
+
+    Bottom Up Rewriting System --- A method of instruction selection for code
+    generation.  An example is the `BURG
+    <http://www.program-transformation.org/Transform/BURG>`_ tool.
+
+C
+-
+
+**CSE**
+    Common Subexpression Elimination. An optimization that removes common
+    subexpression compuation. For example ``(a+b)*(a+b)`` has two subexpressions
+    that are the same: ``(a+b)``. This optimization would perform the addition
+    only once and then perform the multiply (but only if it's compulationally
+    correct/safe).
+
+D
+-
+
+**DAG**
+    Directed Acyclic Graph
+
+.. _derived pointer:
+.. _derived pointers:
+
+**Derived Pointer**
+    A pointer to the interior of an object, such that a garbage collector is
+    unable to use the pointer for reachability analysis. While a derived pointer
+    is live, the corresponding object pointer must be kept in a root, otherwise
+    the collector might free the referenced object. With copying collectors,
+    derived pointers pose an additional hazard that they may be invalidated at
+    any `safe point`_. This term is used in opposition to `object pointer`_.
+
+**DSA**
+    Data Structure Analysis
+
+**DSE**
+    Dead Store Elimination
+
+F
+-
+
+**FCA**
+    First Class Aggregate
+
+G
+-
+
+**GC**
+    Garbage Collection. The practice of using reachability analysis instead of
+    explicit memory management to reclaim unused memory.
+
+H
+-
+
+.. _heap:
+
+**Heap**
+    In garbage collection, the region of memory which is managed using
+    reachability analysis.
+
+I
+-
+
+**IPA**
+    Inter-Procedural Analysis. Refers to any variety of code analysis that
+    occurs between procedures, functions or compilation units (modules).
+
+**IPO**
+    Inter-Procedural Optimization. Refers to any variety of code optimization
+    that occurs between procedures, functions or compilation units (modules).
+
+**ISel**
+    Instruction Selection
+
+L
+-
+
+**LCSSA**
+    Loop-Closed Static Single Assignment Form
+
+**LICM**
+    Loop Invariant Code Motion
+
+**Load-VN**
+    Load Value Numbering
+
+**LTO**
+    Link-Time Optimization
+
+M
+-
+
+**MC**
+    Machine Code
+
+O
+-
+.. _object pointer:
+.. _object pointers:
+
+**Object Pointer**
+    A pointer to an object such that the garbage collector is able to trace
+    references contained within the object. This term is used in opposition to
+    `derived pointer`_.
+
+P
+-
+
+**PRE**
+    Partial Redundancy Elimination
+
+R
+-
+
+**RAUW**
+
+    Replace All Uses With. The functions ``User::replaceUsesOfWith()``,
+    ``Value::replaceAllUsesWith()``, and
+    ``Constant::replaceUsesOfWithOnConstant()`` implement the replacement of one
+    Value with another by iterating over its def/use chain and fixing up all of
+    the pointers to point to the new value.  See
+    also `def/use chains <ProgrammersManual.html#iterate_chains>`_.
+
+**Reassociation**
+    Rearranging associative expressions to promote better redundancy elimination
+    and other optimization.  For example, changing ``(A+B-A)`` into ``(B+A-A)``,
+    permitting it to be optimized into ``(B+0)`` then ``(B)``.
+
+.. _roots:
+.. _stack roots:
+
+**Root**
+    In garbage collection, a pointer variable lying outside of the `heap`_ from
+    which the collector begins its reachability analysis. In the context of code
+    generation, "root" almost always refers to a "stack root" --- a local or
+    temporary variable within an executing function.</dd>
+
+**RPO**
+    Reverse postorder
+
+S
+-
+
+.. _safe point:
+
+**Safe Point**
+    In garbage collection, it is necessary to identify `stack roots`_ so that
+    reachability analysis may proceed. It may be infeasible to provide this
+    information for every instruction, so instead the information may is
+    calculated only at designated safe points. With a copying collector,
+    `derived pointers`_ must not be retained across safe points and `object
+    pointers`_ must be reloaded from stack roots.
+
+**SDISel**
+    Selection DAG Instruction Selection.
+
+**SCC**
+    Strongly Connected Component
+
+**SCCP**
+    Sparse Conditional Constant Propagation
+
+**SRoA**
+    Scalar Replacement of Aggregates
+
+**SSA**
+    Static Single Assignment
+
+**Stack Map**
+    In garbage collection, metadata emitted by the code generator which
+    identifies `roots`_ within the stack frame of an executing function.
diff --git a/docs/userguides.rst b/docs/userguides.rst
index 3e8fb4c..0d1f3fb 100644
--- a/docs/userguides.rst
+++ b/docs/userguides.rst
@@ -8,6 +8,7 @@ User Guides
 
    CommandGuide/index
    FAQ
+   Lexicon
 
 * `The LLVM Getting Started Guide <GettingStarted.html>`_
     
@@ -69,7 +70,7 @@ User Guides
 
    Advice on packaging LLVM into a distribution.
     
-* `The LLVM Lexicon <Lexicon.html>`_
+* :ref:`lexicon`
 
    Definition of acronyms, terms and concepts used in LLVM.
author	Bill Wendling <isanbard@gmail.com>	2012-06-20 10:36:41 +0000
committer	Bill Wendling <isanbard@gmail.com>	2012-06-20 10:36:41 +0000
commit	5cda9016477b206d1d75b0e3a83ff1597a1f8d12 (patch)
tree	d7852011190e2dc5f06db21f41c4ee5e3366e5d0 /docs
parent	707f2fd26bd36e384b5d78d61a21ee45711768ef (diff)
download	external_llvm-5cda9016477b206d1d75b0e3a83ff1597a1f8d12.zip external_llvm-5cda9016477b206d1d75b0e3a83ff1597a1f8d12.tar.gz external_llvm-5cda9016477b206d1d75b0e3a83ff1597a1f8d12.tar.bz2