diff options
| -rw-r--r-- | llvm/docs/ProgrammingDocumentation.rst | 5 | ||||
| -rw-r--r-- | llvm/docs/Reference.rst | 24 | ||||
| -rw-r--r-- | llvm/docs/SubsystemDocumentation.rst | 28 | ||||
| -rw-r--r-- | llvm/docs/_templates/indexsidebar.html | 2 | ||||
| -rw-r--r-- | llvm/docs/index.rst | 3 |
5 files changed, 35 insertions, 27 deletions
diff --git a/llvm/docs/ProgrammingDocumentation.rst b/llvm/docs/ProgrammingDocumentation.rst index c75431c1d70..6a4d7aa25ba 100644 --- a/llvm/docs/ProgrammingDocumentation.rst +++ b/llvm/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 <CommandGuide/index>`
+ A reference manual for the LLVM command line utilities ("man" pages for LLVM
+ tools).
+
=========
LibFuzzer
=========
diff --git a/llvm/docs/Reference.rst b/llvm/docs/Reference.rst index 2178eb1bc40..49ff6b6e0e2 100644 --- a/llvm/docs/Reference.rst +++ b/llvm/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 <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
-:doc:`LLVM Command Guide <CommandGuide/index>`
- A reference manual for the LLVM command line utilities ("man" pages for LLVM
- tools).
-
:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
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 <http://llvm.org/doxygen/>`_
(`classes <http://llvm.org/doxygen/inherits.html>`_)
`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
-
-`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
- ..
\ No newline at end of file diff --git a/llvm/docs/SubsystemDocumentation.rst b/llvm/docs/SubsystemDocumentation.rst index cac0ce85b1f..69764cbd282 100644 --- a/llvm/docs/SubsystemDocumentation.rst +++ b/llvm/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 <SourceLevelDebugging>`
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 <DependenceGraphs/index>`
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/llvm/docs/_templates/indexsidebar.html b/llvm/docs/_templates/indexsidebar.html index b4f1e4f13eb..1a7b7df3ef6 100644 --- a/llvm/docs/_templates/indexsidebar.html +++ b/llvm/docs/_templates/indexsidebar.html @@ -16,4 +16,6 @@ <ul class="want-points"> <li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li> <li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li> + <li><a href="https://llvm.org/pubs">Publications</a></li> + <li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li> </ul>
\ No newline at end of file diff --git a/llvm/docs/index.rst b/llvm/docs/index.rst index 4e9bee3c337..17a0706a196 100644 --- a/llvm/docs/index.rst +++ b/llvm/docs/index.rst @@ -45,9 +45,6 @@ Several introductory papers and presentations. .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html -`Publications mentioning LLVM <http://llvm.org/pubs>`_ - .. - Documentation ============= |
