docs: Improve navigation for Vectorizers.rst
authorSean Silva <silvas@purdue.edu>
Thu, 20 Dec 2012 22:42:20 +0000 (22:42 +0000)
committerSean Silva <silvas@purdue.edu>
Thu, 20 Dec 2012 22:42:20 +0000 (22:42 +0000)
Add links in the intro paragraph.
Add table of contents.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170790 91177308-0d34-0410-b5e6-96231b3b80d8

docs/Vectorizers.rst

index fc1f212ca9eb5157d4088196f5e5b47b895adf29..d5bc90b0a4e92ffa83f2f3e0ff15bb121e7a7db5 100644 (file)
@@ -2,12 +2,18 @@
 Auto-Vectorization in LLVM
 ==========================
 
-LLVM has two vectorizers: The *Loop Vectorizer*, which operates on Loops,
-and the *Basic Block Vectorizer*, which optimizes straight-line code. These
-vectorizers focus on different optimization opportunities and use different
-techniques. The BB vectorizer merges multiple scalars that are found in the
-code into vectors while the Loop Vectorizer widens instructions in the
-original loop to operate on multiple consecutive loop iterations.
+.. contents::
+   :local:
+
+LLVM has two vectorizers: The :ref:`Loop Vectorizer <loop-vectorizer>`,
+which operates on Loops, and the :ref:`Basic Block Vectorizer
+<bb-vectorizer>`, which optimizes straight-line code. These vectorizers
+focus on different optimization opportunities and use different techniques.
+The BB vectorizer merges multiple scalars that are found in the code into
+vectors while the Loop Vectorizer widens instructions in the original loop
+to operate on multiple consecutive loop iterations.
+
+.. _loop-vectorizer:
 
 The Loop Vectorizer
 ===================
@@ -209,6 +215,8 @@ The Y-axis shows the time in msec. Lower is better. The last column shows the ge
 .. image:: gcc-loops.png
    :width: 100%
 
+.. _bb-vectorizer:
+
 The Basic Block Vectorizer
 ==========================