From 25c8f8bcba4c2cf1e377a6b2060a4c6aac304b0c Mon Sep 17 00:00:00 2001 From: DeForest Richards Date: Sun, 29 Sep 2019 15:31:52 +0000 Subject: [PATCH] [Docs] Moves article links to new pages Moves existing article links on the Programming, Subsystem, and Reference documentation pages to new locations. Also moves Github Repository and Publications links to the sidebar. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@373169 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/ProgrammingDocumentation.rst | 5 +++++ docs/Reference.rst | 24 ++++++++++++++++-------- docs/SubsystemDocumentation.rst | 28 ++++++++++++---------------- docs/_templates/indexsidebar.html | 2 ++ docs/index.rst | 3 --- 5 files changed, 35 insertions(+), 27 deletions(-) diff --git a/docs/ProgrammingDocumentation.rst b/docs/ProgrammingDocumentation.rst index c75431c1d70..6a4d7aa25ba 100644 --- a/docs/ProgrammingDocumentation.rst +++ b/docs/ProgrammingDocumentation.rst @@ -8,6 +8,7 @@ For developers of applications which use LLVM as a library. Atomics CommandLine + CommandGuide/index ExtendingLLVM HowToSetUpLLVMStyleRTTI ProgrammersManual @@ -51,6 +52,10 @@ Command Line :doc:`OptBisect` A command line option for debugging optimization-induced failures. +:doc:`LLVM Command Guide ` + A reference manual for the LLVM command line utilities ("man" pages for LLVM + tools). + ========= LibFuzzer ========= diff --git a/docs/Reference.rst b/docs/Reference.rst index 2178eb1bc40..49ff6b6e0e2 100644 --- a/docs/Reference.rst +++ b/docs/Reference.rst @@ -7,19 +7,20 @@ LLVM and API reference documentation. :hidden: LangRef - CommandGuide/index TestingGuide CompilerWriterInfo MIRLangRef + NVPTXUsage + AMDGPUUsage + +============== +LLVM Reference +============== :doc:`LLVM Language Reference Manual ` Defines the LLVM intermediate representation and the assembly form of the different nodes. -:doc:`LLVM Command Guide ` - A reference manual for the LLVM command line utilities ("man" pages for LLVM - tools). - :doc:`LLVM Testing Infrastructure Guide ` A reference manual for using the LLVM testing infrastructure. @@ -30,10 +31,17 @@ LLVM and API reference documentation. A reference manual for the MIR serialization format, which is used to test LLVM's code generation passes. +:doc:`NVPTXUsage` + This document describes using the NVPTX backend to compile GPU kernels. + +:doc:`AMDGPUUsage` + This document describes using the AMDGPU backend to compile GPU kernels. + +============= +API Reference +============= + `Doxygen generated documentation `_ (`classes `_) `Documentation for Go bindings `_ - -`Github Source Repository Browser `_ - .. \ No newline at end of file diff --git a/docs/SubsystemDocumentation.rst b/docs/SubsystemDocumentation.rst index cac0ce85b1f..69764cbd282 100644 --- a/docs/SubsystemDocumentation.rst +++ b/docs/SubsystemDocumentation.rst @@ -32,8 +32,6 @@ For API clients and LLVM developers. GarbageCollection WritingAnLLVMPass HowToUseAttributes - NVPTXUsage - AMDGPUUsage StackMaps InAlloca BigEndianNEON @@ -77,10 +75,6 @@ For API clients and LLVM developers. :doc:`MemorySSA` Information about the MemorySSA utility in LLVM, as well as how to use it. -:doc:`GarbageCollection` - The interfaces source-language compilers should use for compiling GC'd - programs. - :doc:`Source Level Debugging with LLVM ` This document describes the design and philosophy behind the LLVM source-level debugger. @@ -140,12 +134,6 @@ For API clients and LLVM developers. :doc:`HowToUseAttributes` Answers some questions about the new Attributes infrastructure. -:doc:`NVPTXUsage` - This document describes using the NVPTX backend to compile GPU kernels. - -:doc:`AMDGPUUsage` - This document describes using the AMDGPU backend to compile GPU kernels. - :doc:`StackMaps` LLVM support for mapping instruction addresses to the location of values and allowing code to be patched. @@ -157,10 +145,6 @@ For API clients and LLVM developers. :doc:`CoverageMappingFormat` This describes the format and encoding used for LLVM’s code coverage mapping. -:doc:`Statepoints` - This describes a set of experimental extensions for garbage - collection support. - :doc:`MergeFunctions` Describes functions merging optimization. @@ -204,3 +188,15 @@ For API clients and LLVM developers. :doc:`Dependence Graphs ` A description of the design of the various dependence graphs such as the DDG (Data Dependence Graph). + +================== +Garbage Collection +================== + +:doc:`GarbageCollection` + The interfaces source-language compilers should use for compiling GC'd + programs. + +:doc:`Statepoints` + This describes a set of experimental extensions for garbage + collection support. diff --git a/docs/_templates/indexsidebar.html b/docs/_templates/indexsidebar.html index b4f1e4f13eb..1a7b7df3ef6 100644 --- a/docs/_templates/indexsidebar.html +++ b/docs/_templates/indexsidebar.html @@ -16,4 +16,6 @@ \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 4e9bee3c337..17a0706a196 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -45,9 +45,6 @@ Several introductory papers and presentations. .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html -`Publications mentioning LLVM `_ - .. - Documentation ============= -- 2.50.1