docs: fix misleading description.

[oota-llvm.git] / docs / userguides.rst

diff --git a/docs/userguides.rst b/docs/userguides.rst
index 0d1f3fb46aaed028e768c045585bdaa8f862d344..c0a4356b0e151685dbe0bf73b2e1dea2da19f117 100644 (file)
--- a/docs/userguides.rst
+++ b/docs/userguides.rst
@@ -6,33 +6,52 @@ User Guides
 .. toctree::
    :hidden:
 
+   CMake
+   HowToBuildOnARM
    CommandGuide/index
+   DeveloperPolicy
+   GettingStarted
+   GettingStartedVS
    FAQ
    Lexicon
-
-* `The LLVM Getting Started Guide <GettingStarted.html>`_
+   Packaging
+   HowToAddABuilder
+   yaml2obj
+   HowToSubmitABug
+   SphinxQuickstartTemplate
+   Phabricator
+   TestingGuide
+   tutorial/index
+   ReleaseNotes
+   Passes
+   YamlIO
+
+* :ref:`getting_started`
     
    Discusses how to get up and running quickly with the LLVM infrastructure.
    Everything from unpacking and compilation of the distribution to execution
    of some tools.
     
-* `LLVM CMake guide <CMake.html>`_
+* :ref:`building-with-cmake`
 
    An addendum to the main Getting Started guide for those using the `CMake
    build system <http://www.cmake.org>`_.
-    
-* `Getting Started with the LLVM System using Microsoft Visual Studio
-  <GettingStartedVS.html>`_
+
+* :ref:`how_to_build_on_arm`
+
+   Notes on building and testing LLVM/Clang on ARM.
+
+* :doc:`GettingStartedVS`
 
    An addendum to the main Getting Started guide for those using Visual Studio
    on Windows.
     
-* `LLVM Tutorial <tutorial/>`_
+* :doc:`tutorial/index`
 
-   A walk through the process of using LLVM for a custom language, and the
-   facilities LLVM offers in tutorial form.
+   Tutorials about using LLVM. Includes a tutorial about making a custom
+   language with LLVM.
 
-* `Developer Policy <DeveloperPolicy.html>`_
+* :ref:`developer_policy`
 
    The LLVM project's policy towards developers and their contributions.
 
@@ -41,24 +60,28 @@ User Guides
    A reference manual for the LLVM command line utilities ("man" pages for LLVM
    tools).
     
-* `LLVM's Analysis and Transform Passes <Passes.html>`_
+* :doc:`Passes`
 
    A list of optimizations and analyses implemented in LLVM.
-    
+
 * :ref:`faq`
 
    A list of common questions and problems and their solutions.
     
-* `Release notes for the current release <ReleaseNotes.html>`_
+* :doc:`Release notes for the current release <ReleaseNotes>`
 
    This describes new features, known bugs, and other limitations.
 
-* `How to Submit A Bug Report <HowToSubmitABug.html>`_
+* :ref:`how-to-submit-a-bug-report`
     
    Instructions for properly submitting information about any bugs you run into
    in the LLVM system.
+* :doc:`SphinxQuickstartTemplate`
+
+  A template + tutorial for writing new Sphinx documentation. It is meant
+  to be read in source form.
     
-* `LLVM Testing Infrastructure Guide <TestingGuide.html>`_
+* :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
 
    A reference manual for using the LLVM testing infrastructure.
     
@@ -66,7 +89,7 @@ User Guides
 
    Instructions for building the clang front-end from source.
     
-* `Packaging guide <Packaging.html>`_
+* :ref:`packaging`
 
    Advice on packaging LLVM into a distribution.
     
@@ -74,10 +97,14 @@ User Guides
 
    Definition of acronyms, terms and concepts used in LLVM.
 
-* `How To Add Your Build Configuration To LLVM Buildbot Infrastructure <HowToAddABuilder.html>`_
+* :ref:`how_to_add_a_builder`
 
    Instructions for adding new builder to LLVM buildbot master.
     
+* :ref:`yamlio`
+
+   A reference guide for using LLVM's YAML I/O library.
+
 * **IRC** -- You can probably find help on the unofficial LLVM IRC.
 
    We often are on irc.oftc.net in the #llvm channel.  If you are using the