2019-09-25 08:49:02 +08:00
|
|
|
Reference
|
|
|
|
=========
|
|
|
|
|
|
|
|
LLVM and API reference documentation.
|
|
|
|
|
2019-10-06 23:36:37 +08:00
|
|
|
.. contents::
|
|
|
|
:local:
|
|
|
|
|
2019-09-25 08:49:02 +08:00
|
|
|
.. toctree::
|
|
|
|
:hidden:
|
|
|
|
|
2019-10-06 23:36:37 +08:00
|
|
|
Bugpoint
|
|
|
|
CommandGuide/index
|
2019-09-25 08:49:02 +08:00
|
|
|
CompilerWriterInfo
|
2019-10-06 23:36:37 +08:00
|
|
|
FuzzingLLVM
|
|
|
|
GarbageCollection
|
|
|
|
GetElementPtr
|
|
|
|
LangRef
|
|
|
|
LibFuzzer
|
2019-09-25 08:49:02 +08:00
|
|
|
MIRLangRef
|
2019-10-06 23:36:37 +08:00
|
|
|
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>`_
|
2019-09-29 23:31:52 +08:00
|
|
|
|
|
|
|
LLVM Reference
|
2019-10-06 23:36:37 +08:00
|
|
|
--------------
|
2019-09-25 08:49:02 +08:00
|
|
|
|
|
|
|
:doc:`LLVM Language Reference Manual <LangRef>`
|
|
|
|
Defines the LLVM intermediate representation and the assembly form of the
|
|
|
|
different nodes.
|
|
|
|
|
|
|
|
:doc:`CompilerWriterInfo`
|
|
|
|
A list of helpful links for compiler writers.
|
|
|
|
|
|
|
|
: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.
|
|
|
|
|
2019-10-06 23:36:37 +08:00
|
|
|
:doc:`YamlIO`
|
|
|
|
A reference guide for using LLVM's YAML I/O library.
|
2019-09-29 23:31:52 +08:00
|
|
|
|
2019-10-06 23:36:37 +08:00
|
|
|
:doc:`GetElementPtr`
|
|
|
|
Answers to some very frequent questions about LLVM's most frequently
|
|
|
|
misunderstood instruction.
|
2019-09-29 23:31:52 +08:00
|
|
|
|
2019-10-06 23:36:37 +08:00
|
|
|
======================
|
|
|
|
Command Line Utilities
|
|
|
|
======================
|
2019-09-29 23:31:52 +08:00
|
|
|
|
2019-10-06 23:36:37 +08:00
|
|
|
:doc:`LLVM Command Guide <CommandGuide/index>`
|
|
|
|
A reference manual for the LLVM command line utilities ("man" pages for LLVM
|
|
|
|
tools).
|
2019-09-25 08:49:02 +08:00
|
|
|
|
2019-10-06 23:36:37 +08:00
|
|
|
: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.
|