RPCS3/llvm-mirror
1
0
Fork 0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-25 04:02:41 +01:00
Code Issues Projects Releases Wiki Activity

[Docs] Adds Documentation links to sidebar

Browse Source 
Adds links to Getting Started/Tutorials, User Guides, and Reference documentation pages to sidebar. Also adds a new section for LLVM IR on the Reference documentation page.

llvm-svn: 374214
This commit is contained in:
DeForest Richards 2019-10-09 20:26:13 +00:00
parent affeff0d1b
commit f358a34083
3 changed files with 34 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/GettingStartedTutorials.rst
View File

@ -6,6 +6,7 @@ For those new to the LLVM system.
.. toctree::
:hidden:
CompilerWriterInfo
Frontend/PerformanceTips
GettingStarted
GettingStartedVS
@ -31,4 +32,7 @@ For those new to the LLVM system.
:doc:`GettingStartedVS`
An addendum to the main Getting Started guide for those using Visual Studio
on Windows.
on Windows.
:doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.

42
docs/Reference.rst
View File

@ -16,7 +16,6 @@ LLVM and API reference documentation.
Bugpoint
CFIVerify
CommandGuide/index
CompilerWriterInfo
Coroutines
DependenceGraphs/index
ExceptionHandling
@ -68,23 +67,9 @@ API Reference
LLVM Reference
--------------
:doc:`LLVM Language Reference Manual <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
:doc:`FaultMaps`
LLVM support for folding control flow into faulting machine instructions.
:doc:`InAlloca`
Description of the ``inalloca`` argument attribute.
: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.
:doc:`GlobalISel`
This describes the prototype instruction selection replacement, GlobalISel.
:doc:`Atomics`
Information about LLVM's concurrency model.
@ -92,12 +77,6 @@ LLVM Reference
This document describes the design and implementation of exception handling
in LLVM.
:doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.
:doc:`BitCodeFormat`
This describes the file format and encoding used for LLVM "bc" files.
:doc:`Extensions`
LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
@ -198,6 +177,27 @@ LibFuzzer
:doc:`FuzzingLLVM`
Information on writing and using Fuzzers to find bugs in LLVM.
========
LLVM IR
========
:doc:`LLVM Language Reference Manual <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
:doc:`InAlloca`
Description of the ``inalloca`` argument attribute.
:doc:`BitCodeFormat`
This describes the file format and encoding used for LLVM "bc" files.
: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.
:doc:`GlobalISel`
This describes the prototype instruction selection replacement, GlobalISel.
=======
Testing
=======

8
docs/_templates/indexsidebar.html vendored
View File

@ -1,6 +1,14 @@
{# This template defines sidebar which can be used to provide common links on
all documentation pages. #}
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">