[Docs] Move topics to new categories
authorDeForest Richards <d4m1887@gmail.com>
Fri, 20 Sep 2019 20:51:33 +0000 (20:51 +0000)
committerDeForest Richards <d4m1887@gmail.com>
Fri, 20 Sep 2019 20:51:33 +0000 (20:51 +0000)
This commit moves several topics to new categories.

llvm-svn: 372428

llvm/docs/ProgrammingDocumentation.rst
llvm/docs/SubsystemDocumentation.rst
llvm/docs/UserGuides.rst
llvm/docs/index.rst

index 85bf392..fa8f114 100644 (file)
@@ -7,9 +7,7 @@ For developers of applications which use LLVM as a library.
    :hidden:\r
 \r
    Atomics\r
-   CodingStandards\r
    CommandLine\r
-   CompilerWriterInfo\r
    ExtendingLLVM\r
    HowToSetUpLLVMStyleRTTI\r
    ProgrammersManual\r
@@ -33,10 +31,6 @@ For developers of applications which use LLVM as a library.
 :doc:`CommandLine`\r
   Provides information on using the command line parsing library.\r
 \r
-:doc:`CodingStandards`\r
-  Details the LLVM coding standards and provides useful information on writing\r
-  efficient C++ code.\r
-\r
 :doc:`HowToSetUpLLVMStyleRTTI`\r
   How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your\r
   class hierarchy.\r
@@ -44,9 +38,6 @@ For developers of applications which use LLVM as a library.
 :doc:`ExtendingLLVM`\r
   Look here to see how to add instructions and intrinsics to LLVM.\r
 \r
-:doc:`CompilerWriterInfo`\r
-  A list of helpful links for compiler writers.\r
-\r
 :doc:`LibFuzzer`\r
   A library for writing in-process guided fuzzers.\r
 \r
index 2d3882a..cac0ce8 100644 (file)
@@ -43,7 +43,6 @@ For API clients and LLVM developers.
    TypeMetadata\r
    TransformMetadata\r
    FaultMaps\r
-   MIRLangRef\r
    Coroutines\r
    GlobalISel\r
    XRay\r
@@ -67,10 +66,6 @@ For API clients and LLVM developers.
    working on retargetting LLVM to a new architecture, designing a new codegen\r
    pass, or enhancing existing components.\r
 \r
-:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`\r
-   A reference manual for the MIR serialization format, which is used to test\r
-   LLVM's code generation passes.\r
-\r
 :doc:`TableGen <TableGen/index>`\r
    Describes the TableGen tool, which is used heavily by the LLVM code\r
    generator.\r
index 962fd14..9dfab67 100644 (file)
@@ -18,8 +18,6 @@ intermediate LLVM representation.
    HowToBuildWithPGO\r
    HowToCrossCompileBuiltinsOnArm\r
    HowToCrossCompileLLVM\r
-   GettingStartedVS\r
-   FAQ\r
    yaml2obj\r
    MarkdownQuickstartTemplate\r
    Phabricator\r
@@ -53,16 +51,9 @@ intermediate LLVM representation.
 :doc:`HowToCrossCompileLLVM`\r
    Notes on cross-building and testing LLVM/Clang.\r
 \r
-:doc:`GettingStartedVS`\r
-   An addendum to the main Getting Started guide for those using Visual Studio\r
-   on Windows.\r
-\r
 :doc:`Passes`\r
    A list of optimizations and analyses implemented in LLVM.\r
 \r
-:doc:`FAQ`\r
-   A list of common questions and problems and their solutions.\r
-\r
 :doc:`TestSuiteGuide`\r
   Describes how to compile and run the test-suite benchmarks.\r
 \r
index ef7ae86..a9abd97 100644 (file)
@@ -21,11 +21,8 @@ Several introductory papers and presentations.
 .. toctree::
    :hidden:
 
-   LangRef
    Lexicon
-
-:doc:`LangRef`
-  Defines the LLVM intermediate representation.
+   FAQ
 
 `Introduction to the LLVM Compiler`__
   Presentation providing a users introduction to LLVM.
@@ -54,6 +51,9 @@ Several introductory papers and presentations.
 :doc:`Lexicon`
    Definition of acronyms, terms and concepts used in LLVM.
 
+:doc:`FAQ`
+   A list of common questions and problems and their solutions.
+
 Documentation
 =============
 
@@ -83,6 +83,7 @@ Getting Started/Tutorials
 
    GettingStarted
    tutorial/index
+   GettingStartedVS
 
 :doc:`GettingStarted`
    Discusses how to get up and running quickly with the LLVM infrastructure.
@@ -93,6 +94,10 @@ Getting Started/Tutorials
    Tutorials about using LLVM. Includes a tutorial about making a custom
    language with LLVM.
 
+:doc:`GettingStartedVS`
+   An addendum to the main Getting Started guide for those using Visual Studio
+   on Windows.
+
 Reference
 ---------
 
@@ -104,8 +109,11 @@ LLVM and API reference documentation.
 .. toctree::
    :hidden:
 
+   LangRef
    CommandGuide/index
    TestingGuide
+   CompilerWriterInfo
+   MIRLangRef
 
 :doc:`LLVM Language Reference Manual <LangRef>`
   Defines the LLVM intermediate representation and the assembly form of the
@@ -118,6 +126,13 @@ LLVM and API reference documentation.
 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
    A reference manual for using the LLVM testing infrastructure.
 
+:doc:`CompilerWriterInfo`
+  A list of helpful links for compiler writers.
+
+:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
+   A reference manual for the MIR serialization format, which is used to test
+   LLVM's code generation passes.
+
 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
   (`classes <http://llvm.org/doxygen/inherits.html>`_)
 
@@ -147,6 +162,7 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll
    Phabricator
    HowToSubmitABug
    BugLifeCycle
+   CodingStandards
 
 :doc:`Contributing`
    An overview on how to contribute to LLVM.
@@ -169,6 +185,10 @@ LLVM welcomes contributions of all kinds. To get started, please review the foll
 :doc:`BugLifeCycle`
    Describes how bugs are reported, triaged and closed.
 
+:doc:`CodingStandards`
+  Details the LLVM coding standards and provides useful information on writing
+  efficient C++ code.
+
 Development Process
 -------------------