[Docs] Removes Programming Documentation page

Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages.

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

diff --git a/docs/GettingStartedTutorials.rst b/docs/GettingStartedTutorials.rst
index 60a5ddf7c06dae1a8562fff6a566aff449c2b8fc..a8d60343ddc5b13ab52ffefe3f583632dc09ae6a 100644 (file)
--- a/docs/GettingStartedTutorials.rst
+++ b/docs/GettingStartedTutorials.rst
@@ -6,9 +6,10 @@ For those new to the LLVM system.
 .. toctree::\r
    :hidden:\r
 \r
+   Frontend/PerformanceTips\r
    GettingStarted\r
    GettingStartedVS\r
-   Frontend/PerformanceTips\r
+   ProgrammersManual\r
    tutorial/index\r
 \r
 :doc:`GettingStarted`\r
@@ -20,10 +21,14 @@ For those new to the LLVM system.
    Tutorials about using LLVM. Includes a tutorial about making a custom\r
    language with LLVM.\r
 \r
-:doc:`GettingStartedVS`\r
-   An addendum to the main Getting Started guide for those using Visual Studio\r
-   on Windows.\r
+:doc:`ProgrammersManual`\r
+  Introduction to the general layout of the LLVM sourcebase, important classes\r
+  and APIs, and some tips & tricks.\r
 \r
 :doc:`Frontend/PerformanceTips`\r
    A collection of tips for frontend authors on how to generate IR\r
-   which LLVM is able to effectively optimize.
\ No newline at end of file
+   which LLVM is able to effectively optimize.\r
+\r
+:doc:`GettingStartedVS`\r
+   An addendum to the main Getting Started guide for those using Visual Studio\r
+   on Windows.
\ No newline at end of file

diff --git a/docs/ProgrammingDocumentation.rst b/docs/ProgrammingDocumentation.rst
deleted file mode 100644 (file)
index a36127a..0000000
--- a/docs/ProgrammingDocumentation.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-Programming Documentation\r
-=========================\r
-\r
-For developers of applications which use LLVM as a library.\r
-\r
-.. toctree::\r
-   :hidden:\r
-\r
-   Atomics\r
-   CommandLine\r
-   ExtendingLLVM\r
-   HowToSetUpLLVMStyleRTTI\r
-   ProgrammersManual\r
-   Extensions\r
-   ScudoHardenedAllocator\r
-   OptBisect\r
-   GwpAsan\r
-\r
-:doc:`Atomics`\r
-  Information about LLVM's concurrency model.\r
-\r
-:doc:`ProgrammersManual`\r
-  Introduction to the general layout of the LLVM sourcebase, important classes\r
-  and APIs, and some tips & tricks.\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:`ExtendingLLVM`\r
-  Look here to see how to add instructions and intrinsics to LLVM.\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:`CommandLine`\r
-  Provides information on using the command line parsing library.\r
-\r
-:doc:`OptBisect`\r
-  A command line option for debugging optimization-induced failures.
\ No newline at end of file

diff --git a/docs/Reference.rst b/docs/Reference.rst
index 9346d4d7608f772823ed21a8510d1b453fece41b..0e55be30266707985e0abf0947f25a49e78e918a 100644 (file)
--- a/docs/Reference.rst
+++ b/docs/Reference.rst
@@ -9,16 +9,22 @@ LLVM and API reference documentation.
 .. toctree::\r
    :hidden:\r
 \r
+   Atomics\r
    Bugpoint\r
    CommandGuide/index\r
    CompilerWriterInfo\r
+   Extensions\r
    FuzzingLLVM\r
    GarbageCollection\r
    GetElementPtr\r
+   GwpAsan\r
+   HowToSetUpLLVMStyleRTTI\r
    LangRef\r
    LibFuzzer\r
    MIRLangRef\r
+   OptBisect\r
    PDB/index\r
+   ScudoHardenedAllocator\r
    Statepoints\r
    TestingGuide\r
    YamlIO\r
@@ -38,20 +44,36 @@ LLVM Reference
   Defines the LLVM intermediate representation and the assembly form of the\r
   different nodes.\r
 \r
-:doc:`CompilerWriterInfo`\r
-  A list of helpful links for compiler writers.\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:`YamlIO`\r
-   A reference guide for using LLVM's YAML I/O library.\r
+:doc:`Atomics`\r
+  Information about LLVM's concurrency model.\r
+\r
+:doc:`CompilerWriterInfo`\r
+  A list of helpful links for compiler writers.\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:`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:`YamlIO`\r
+   A reference guide for using LLVM's YAML I/O library.\r
+\r
 ======================\r
 Command Line Utilities\r
 ======================\r
@@ -64,6 +86,9 @@ Command Line Utilities
    Automatic bug finder and test-case reducer description and usage\r
    information.\r
 \r
+:doc:`OptBisect`\r
+  A command line option for debugging optimization-induced failures.\r
+\r
 :doc:`The Microsoft PDB File Format <PDB/index>`\r
   A detailed description of the Microsoft PDB (Program Database) file format.\r
 \r

diff --git a/docs/UserGuides.rst b/docs/UserGuides.rst
index 7016a52380ee3ffd4fa45016762b0dbc3f3a85fb..ddb3acf6fbd781f5063981beee727fce047b82ad 100644 (file)
--- a/docs/UserGuides.rst
+++ b/docs/UserGuides.rst
@@ -37,6 +37,8 @@ intermediate LLVM representation.
    TableGen/index\r
    NVPTXUsage\r
    AMDGPUUsage\r
+   ExtendingLLVM\r
+   CommandLine\r
 \r
 Clang\r
 -----\r
@@ -102,6 +104,12 @@ Code Generation
 Additional Topics\r
 -----------------\r
 \r
+:doc:`CommandLine`\r
+  Provides information on using the command line parsing library.\r
+\r
+:doc:`ExtendingLLVM`\r
+  Look here to see how to add instructions and intrinsics to LLVM.\r
+\r
 :doc:`HowToCrossCompileBuiltinsOnArm`\r
    Notes on cross-building and testing the compiler-rt builtins for Arm.\r
 \r

diff --git a/docs/index.rst b/docs/index.rst
index f64979ea44ac9ad7f26bd5e07b635531d33eab5d..c5ddabfe0404e5776378a6b786689b458387df20 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -54,7 +54,6 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
    :hidden:
 
    GettingStartedTutorials
-   ProgrammingDocumentation
    Reference
    SubsystemDocumentation
    UserGuides
@@ -65,9 +64,6 @@ Getting Started, How-tos, Developer Guides, and Tutorials.
 :doc:`UserGuides`
   User guides and How-tos.
 
-:doc:`ProgrammingDocumentation`
-  For developers of applications which use LLVM as a library.
-
 :doc:`SubsystemDocumentation`
   For API clients and LLVM developers.