[Docs] Adds section for Additional Topics on Reference page

Adds a new section for Additional Topics on the Reference documentation page. Also moves Support Library topic to User Guides page.

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

diff --git a/docs/Reference.rst b/docs/Reference.rst
index c18b6d01375dd3631cfd9bbd7143fa8ecdd89e4e..882d0dc9ab1209332e71a2219e2578e612e4e853 100644 (file)
--- a/docs/Reference.rst
+++ b/docs/Reference.rst
@@ -32,7 +32,6 @@ LLVM and API reference documentation.
    LangRef\r
    LibFuzzer\r
    MarkedUpDisassembly\r
-   MemorySSA\r
    MIRLangRef\r
    OptBisect\r
    ORCv2\r
@@ -41,7 +40,6 @@ LLVM and API reference documentation.
    SegmentedStacks\r
    StackMaps\r
    SpeculativeLoadHardening\r
-   SupportLibrary\r
    Statepoints\r
    SystemLibrary\r
    TestingGuide\r
@@ -58,6 +56,9 @@ API Reference
 `Doxygen generated documentation <http://llvm.org/doxygen/>`_\r
   (`classes <http://llvm.org/doxygen/inherits.html>`_)\r
 \r
+:doc:`HowToUseAttributes`\r
+  Answers some questions about the new Attributes infrastructure.\r
+\r
 `Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_\r
 \r
 :doc:`ORCv2`\r
@@ -67,76 +68,6 @@ API Reference
 LLVM Reference\r
 --------------\r
 \r
-:doc:`FaultMaps`\r
-  LLVM support for folding control flow into faulting machine instructions.\r
-\r
-:doc:`Atomics`\r
-  Information about LLVM's concurrency model.\r
-\r
-:doc:`ExceptionHandling`\r
-   This document describes the design and implementation of exception handling\r
-   in LLVM.\r
-\r
-:doc:`Extensions`\r
-  LLVM-specific extensions to tools and formats LLVM seeks compatibility with.\r
-\r
-:doc:`HowToSetUpLLVMStyleRTTI`\r
-  How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your\r
-  class hierarchy.\r
-\r
-:doc:`BlockFrequencyTerminology`\r
-   Provides information about terminology used in the ``BlockFrequencyInfo``\r
-   analysis pass.\r
-\r
-:doc:`BranchWeightMetadata`\r
-   Provides information about Branch Prediction Information.\r
-\r
-:doc:`MemorySSA`\r
-   Information about the MemorySSA utility in LLVM, as well as how to use it.\r
-\r
-:doc:`Support Library <SupportLibrary>`\r
-   This document describes the LLVM Support Library (``lib/Support``) and\r
-   how to keep LLVM source code portable\r
-\r
-:doc:`GetElementPtr`\r
-  Answers to some very frequent questions about LLVM's most frequently\r
-  misunderstood instruction.\r
-\r
-:doc:`ScudoHardenedAllocator`\r
-  A library that implements a security-hardened `malloc()`.\r
-\r
-:doc:`GwpAsan`\r
-  A sampled heap memory error detection toolkit designed for production use.\r
-\r
-:doc:`Dependence Graphs <DependenceGraphs/index>`\r
-  A description of the design of the various dependence graphs such as\r
-  the DDG (Data Dependence Graph).\r
-\r
-:doc:`CFIVerify`\r
-  A description of the verification tool for Control Flow Integrity.\r
-\r
-:doc:`SpeculativeLoadHardening`\r
-  A description of the Speculative Load Hardening mitigation for Spectre v1.\r
-\r
-:doc:`SegmentedStacks`\r
-   This document describes segmented stacks and how they are used in LLVM.\r
-\r
-:doc:`MarkedUpDisassembly`\r
-   This document describes the optional rich disassembly output syntax.\r
-\r
-:doc:`HowToUseAttributes`\r
-  Answers some questions about the new Attributes infrastructure.\r
-\r
-:doc:`StackMaps`\r
-  LLVM support for mapping instruction addresses to the location of\r
-  values and allowing code to be patched.\r
-\r
-:doc:`Coroutines`\r
-  LLVM support for coroutines.\r
-\r
-:doc:`YamlIO`\r
-   A reference guide for using LLVM's YAML I/O library.\r
-\r
 ======================\r
 Command Line Utilities\r
 ======================\r
@@ -216,4 +147,68 @@ XRay
   High-level documentation of how to use XRay in LLVM.\r
 \r
 :doc:`XRayExample`\r
-  An example of how to debug an application with XRay.
\ No newline at end of file
+  An example of how to debug an application with XRay.\r
+\r
+=================\r
+Additional Topics\r
+=================\r
+\r
+:doc:`FaultMaps`\r
+  LLVM support for folding control flow into faulting machine instructions.\r
+\r
+:doc:`Atomics`\r
+  Information about LLVM's concurrency model.\r
+\r
+:doc:`ExceptionHandling`\r
+   This document describes the design and implementation of exception handling\r
+   in LLVM.\r
+\r
+:doc:`Extensions`\r
+  LLVM-specific extensions to tools and formats LLVM seeks compatibility with.\r
+\r
+:doc:`HowToSetUpLLVMStyleRTTI`\r
+  How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your\r
+  class hierarchy.\r
+\r
+:doc:`BlockFrequencyTerminology`\r
+   Provides information about terminology used in the ``BlockFrequencyInfo``\r
+   analysis pass.\r
+\r
+:doc:`BranchWeightMetadata`\r
+   Provides information about Branch Prediction Information.\r
+\r
+:doc:`GetElementPtr`\r
+  Answers to some very frequent questions about LLVM's most frequently\r
+  misunderstood instruction.\r
+\r
+:doc:`ScudoHardenedAllocator`\r
+  A library that implements a security-hardened `malloc()`.\r
+\r
+:doc:`GwpAsan`\r
+  A sampled heap memory error detection toolkit designed for production use.\r
+\r
+:doc:`Dependence Graphs <DependenceGraphs/index>`\r
+  A description of the design of the various dependence graphs such as\r
+  the DDG (Data Dependence Graph).\r
+\r
+:doc:`CFIVerify`\r
+  A description of the verification tool for Control Flow Integrity.\r
+\r
+:doc:`SpeculativeLoadHardening`\r
+  A description of the Speculative Load Hardening mitigation for Spectre v1.\r
+\r
+:doc:`SegmentedStacks`\r
+   This document describes segmented stacks and how they are used in LLVM.\r
+\r
+:doc:`MarkedUpDisassembly`\r
+   This document describes the optional rich disassembly output syntax.\r
+\r
+:doc:`StackMaps`\r
+  LLVM support for mapping instruction addresses to the location of\r
+  values and allowing code to be patched.\r
+\r
+:doc:`Coroutines`\r
+  LLVM support for coroutines.\r
+\r
+:doc:`YamlIO`\r
+   A reference guide for using LLVM's YAML I/O library.
\ No newline at end of file

diff --git a/docs/UserGuides.rst b/docs/UserGuides.rst
index 5c035d1717d6a984b97819cd9657b0f5859ebbc6..abaa98cc9e7e793c765093140c5cac9570be8271 100644 (file)
--- a/docs/UserGuides.rst
+++ b/docs/UserGuides.rst
@@ -37,6 +37,7 @@ intermediate LLVM representation.
    LinkTimeOptimization\r
    LoopTerminology\r
    MarkdownQuickstartTemplate\r
+   MemorySSA\r
    MergeFunctions\r
    MCJITDesignAndImplementation\r
    NVPTXUsage\r
@@ -44,8 +45,9 @@ intermediate LLVM representation.
    Passes\r
    ReportingGuide\r
    Remarks\r
-   StackSafetyAnalysis\r
    SourceLevelDebugging\r
+   StackSafetyAnalysis\r
+   SupportLibrary\r
    TableGen/index\r
    TableGenFundamentals\r
    Vectorizers\r
@@ -87,6 +89,10 @@ LLVM Builds and Distributions
 :doc:`Docker`\r
    A reference for using Dockerfiles provided with LLVM.\r
 \r
+:doc:`Support Library <SupportLibrary>`\r
+   This document describes the LLVM Support Library (``lib/Support``) and\r
+   how to keep LLVM source code portable\r
+\r
 Optimizations\r
 -------------\r
 \r
@@ -107,6 +113,9 @@ Optimizations
    Information on how to write a new alias analysis implementation or how to\r
    use existing analyses.\r
 \r
+:doc:`MemorySSA`\r
+   Information about the MemorySSA utility in LLVM, as well as how to use it.\r
+\r
 :doc:`LoopTerminology`\r
   A document describing Loops and associated terms as used in LLVM.\r
 \r