Skip to content

Commit eb78dea

Browse files
committed
[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. llvm-svn: 373169
1 parent c513360 commit eb78dea

File tree

5 files changed

+35
-27
lines changed

5 files changed

+35
-27
lines changed

llvm/docs/ProgrammingDocumentation.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ For developers of applications which use LLVM as a library.
88

99
Atomics
1010
CommandLine
11+
CommandGuide/index
1112
ExtendingLLVM
1213
HowToSetUpLLVMStyleRTTI
1314
ProgrammersManual
@@ -51,6 +52,10 @@ Command Line
5152
:doc:`OptBisect`
5253
A command line option for debugging optimization-induced failures.
5354

55+
:doc:`LLVM Command Guide <CommandGuide/index>`
56+
A reference manual for the LLVM command line utilities ("man" pages for LLVM
57+
tools).
58+
5459
=========
5560
LibFuzzer
5661
=========

llvm/docs/Reference.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,20 @@ LLVM and API reference documentation.
77
:hidden:
88

99
LangRef
10-
CommandGuide/index
1110
TestingGuide
1211
CompilerWriterInfo
1312
MIRLangRef
13+
NVPTXUsage
14+
AMDGPUUsage
15+
16+
==============
17+
LLVM Reference
18+
==============
1419

1520
:doc:`LLVM Language Reference Manual <LangRef>`
1621
Defines the LLVM intermediate representation and the assembly form of the
1722
different nodes.
1823

19-
:doc:`LLVM Command Guide <CommandGuide/index>`
20-
A reference manual for the LLVM command line utilities ("man" pages for LLVM
21-
tools).
22-
2324
:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
2425
A reference manual for using the LLVM testing infrastructure.
2526

@@ -30,10 +31,17 @@ LLVM and API reference documentation.
3031
A reference manual for the MIR serialization format, which is used to test
3132
LLVM's code generation passes.
3233

34+
:doc:`NVPTXUsage`
35+
This document describes using the NVPTX backend to compile GPU kernels.
36+
37+
:doc:`AMDGPUUsage`
38+
This document describes using the AMDGPU backend to compile GPU kernels.
39+
40+
=============
41+
API Reference
42+
=============
43+
3344
`Doxygen generated documentation <http://llvm.org/doxygen/>`_
3445
(`classes <http://llvm.org/doxygen/inherits.html>`_)
3546

3647
`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
37-
38-
`Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
39-
..

llvm/docs/SubsystemDocumentation.rst

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ For API clients and LLVM developers.
3232
GarbageCollection
3333
WritingAnLLVMPass
3434
HowToUseAttributes
35-
NVPTXUsage
36-
AMDGPUUsage
3735
StackMaps
3836
InAlloca
3937
BigEndianNEON
@@ -77,10 +75,6 @@ For API clients and LLVM developers.
7775
:doc:`MemorySSA`
7876
Information about the MemorySSA utility in LLVM, as well as how to use it.
7977

80-
:doc:`GarbageCollection`
81-
The interfaces source-language compilers should use for compiling GC'd
82-
programs.
83-
8478
:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
8579
This document describes the design and philosophy behind the LLVM
8680
source-level debugger.
@@ -140,12 +134,6 @@ For API clients and LLVM developers.
140134
:doc:`HowToUseAttributes`
141135
Answers some questions about the new Attributes infrastructure.
142136

143-
:doc:`NVPTXUsage`
144-
This document describes using the NVPTX backend to compile GPU kernels.
145-
146-
:doc:`AMDGPUUsage`
147-
This document describes using the AMDGPU backend to compile GPU kernels.
148-
149137
:doc:`StackMaps`
150138
LLVM support for mapping instruction addresses to the location of
151139
values and allowing code to be patched.
@@ -157,10 +145,6 @@ For API clients and LLVM developers.
157145
:doc:`CoverageMappingFormat`
158146
This describes the format and encoding used for LLVM’s code coverage mapping.
159147

160-
:doc:`Statepoints`
161-
This describes a set of experimental extensions for garbage
162-
collection support.
163-
164148
:doc:`MergeFunctions`
165149
Describes functions merging optimization.
166150

@@ -204,3 +188,15 @@ For API clients and LLVM developers.
204188
:doc:`Dependence Graphs <DependenceGraphs/index>`
205189
A description of the design of the various dependence graphs such as
206190
the DDG (Data Dependence Graph).
191+
192+
==================
193+
Garbage Collection
194+
==================
195+
196+
:doc:`GarbageCollection`
197+
The interfaces source-language compilers should use for compiling GC'd
198+
programs.
199+
200+
:doc:`Statepoints`
201+
This describes a set of experimental extensions for garbage
202+
collection support.

llvm/docs/_templates/indexsidebar.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,6 @@ <h3>Additional Links</h3>
1616
<ul class="want-points">
1717
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
1818
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
19+
<li><a href="https://llvm.org/pubs">Publications</a></li>
20+
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
1921
</ul>

llvm/docs/index.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,6 @@ Several introductory papers and presentations.
4545

4646
.. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
4747

48-
`Publications mentioning LLVM <http://llvm.org/pubs>`_
49-
..
50-
5148
Documentation
5249
=============
5350

0 commit comments

Comments
 (0)