maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/llvm/docs/Reference.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

125 lines
3.0 KiB
ReStructuredText
Raw Normal View History

[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
Reference
=========
LLVM and API reference documentation.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
.. contents::
:local:
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
.. toctree::
:hidden:
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
Atomics
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
Bugpoint
CommandGuide/index
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
CompilerWriterInfo
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
Extensions
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
FuzzingLLVM
GarbageCollection
GetElementPtr
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
GwpAsan
HowToSetUpLLVMStyleRTTI
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
LangRef
LibFuzzer
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
MIRLangRef
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
OptBisect
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
PDB/index
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
ScudoHardenedAllocator
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
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>`_
[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
2019-09-29 23:31:52 +08:00
LLVM Reference
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
--------------
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
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:`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.
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
:doc:`Atomics`
Information about LLVM's concurrency model.
:doc:`CompilerWriterInfo`
A list of helpful links for compiler writers.
:doc:`Extensions`
LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
:doc:`HowToSetUpLLVMStyleRTTI`
How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
class hierarchy.
[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
2019-09-29 23:31:52 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`GetElementPtr`
Answers to some very frequent questions about LLVM's most frequently
misunderstood instruction.
[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
2019-09-29 23:31:52 +08:00
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
:doc:`ScudoHardenedAllocator`
A library that implements a security-hardened `malloc()`.
:doc:`GwpAsan`
A sampled heap memory error detection toolkit designed for production use.
:doc:`YamlIO`
A reference guide for using LLVM's YAML I/O library.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
======================
Command Line Utilities
======================
[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
2019-09-29 23:31:52 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
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).
[Docs] Moves Reference docs to new page Moves Reference docs to new page. Also adds a table of contents to Getting Involved page. llvm-svn: 372796
2019-09-25 08:49:02 +08:00
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
:doc:`Bugpoint`
Automatic bug finder and test-case reducer description and usage
information.
[Docs] Removes Programming Documentation page Removes Programming Documentation page. Also moves existing topics on Programming Documentation page to User Guides and Reference pages. llvm-svn: 373856
2019-10-07 00:10:11 +08:00
:doc:`OptBisect`
A command line option for debugging optimization-induced failures.
[Docs] Adds new Getting Started/Tutorials page Adds a new page for Getting Started/Tutorials topics. Also updates existing topic categories on the User Guides and Reference pages. llvm-svn: 373854
2019-10-06 23:36:37 +08:00
: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.