diff options
Diffstat (limited to 'llvm/docs/Reference.rst')
| -rw-r--r-- | llvm/docs/Reference.rst | 91 |
1 files changed, 72 insertions, 19 deletions
diff --git a/llvm/docs/Reference.rst b/llvm/docs/Reference.rst index 49ff6b6e0e2..9346d4d7608 100644 --- a/llvm/docs/Reference.rst +++ b/llvm/docs/Reference.rst @@ -3,27 +3,41 @@ Reference LLVM and API reference documentation.
+.. contents::
+ :local:
+
.. toctree::
:hidden:
- LangRef
- TestingGuide
+ Bugpoint
+ CommandGuide/index
CompilerWriterInfo
+ FuzzingLLVM
+ GarbageCollection
+ GetElementPtr
+ LangRef
+ LibFuzzer
MIRLangRef
- NVPTXUsage
- AMDGPUUsage
+ PDB/index
+ Statepoints
+ TestingGuide
+ YamlIO
+
+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>`_
-==============
LLVM Reference
-==============
+--------------
:doc:`LLVM Language Reference Manual <LangRef>`
Defines the LLVM intermediate representation and the assembly form of the
different nodes.
-:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
- A reference manual for using the LLVM testing infrastructure.
-
:doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.
@@ -31,17 +45,56 @@ LLVM Reference 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:`YamlIO`
+ A reference guide for using LLVM's YAML I/O library.
-:doc:`AMDGPUUsage`
- This document describes using the AMDGPU backend to compile GPU kernels.
+:doc:`GetElementPtr`
+ Answers to some very frequent questions about LLVM's most frequently
+ misunderstood instruction.
-=============
-API Reference
-=============
+======================
+Command Line Utilities
+======================
-`Doxygen generated documentation <http://llvm.org/doxygen/>`_
- (`classes <http://llvm.org/doxygen/inherits.html>`_)
+:doc:`LLVM Command Guide <CommandGuide/index>`
+ A reference manual for the LLVM command line utilities ("man" pages for LLVM
+ tools).
-`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
+:doc:`Bugpoint`
+ Automatic bug finder and test-case reducer description and usage
+ information.
+
+:doc:`The Microsoft PDB File Format <PDB/index>`
+ A detailed description of the Microsoft PDB (Program Database) file format.
+
+==================
+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.
+
+=========
+LibFuzzer
+=========
+
+:doc:`LibFuzzer`
+ A library for writing in-process guided fuzzers.
+
+:doc:`FuzzingLLVM`
+ Information on writing and using Fuzzers to find bugs in LLVM.
+
+=======
+Testing
+=======
+
+:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
+ A reference manual for using the LLVM testing infrastructure.
+
+:doc:`TestSuiteGuide`
+ Describes how to compile and run the test-suite benchmarks.
\ No newline at end of file |
