Blame - llvm/docs/Reference.rst - toolchain/llvm-project

blob: 0e55be30266707985e0abf0947f25a49e78e918a [file] [log] [blame]

DeForest Richards	ccf6030	2019-09-25 00:49:02 +0000	[diff] [blame]	1	Reference
				2	=========
				3
				4	LLVM and API reference documentation.
				5
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	6	.. contents::
				7	:local:
				8
DeForest Richards	ccf6030	2019-09-25 00:49:02 +0000	[diff] [blame]	9	.. toctree::
				10	:hidden:
				11
DeForest Richards	de0e3aa	2019-10-06 16:10:11 +0000	[diff] [blame^]	12	Atomics
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	13	Bugpoint
				14	CommandGuide/index
DeForest Richards	ccf6030	2019-09-25 00:49:02 +0000	[diff] [blame]	15	CompilerWriterInfo
DeForest Richards	de0e3aa	2019-10-06 16:10:11 +0000	[diff] [blame^]	16	Extensions
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	17	FuzzingLLVM
				18	GarbageCollection
				19	GetElementPtr
DeForest Richards	de0e3aa	2019-10-06 16:10:11 +0000	[diff] [blame^]	20	GwpAsan
				21	HowToSetUpLLVMStyleRTTI
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	22	LangRef
				23	LibFuzzer
DeForest Richards	ccf6030	2019-09-25 00:49:02 +0000	[diff] [blame]	24	MIRLangRef
DeForest Richards	de0e3aa	2019-10-06 16:10:11 +0000	[diff] [blame^]	25	OptBisect
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	26	PDB/index
DeForest Richards	de0e3aa	2019-10-06 16:10:11 +0000	[diff] [blame^]	27	ScudoHardenedAllocator
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	28	Statepoints
				29	TestingGuide
				30	YamlIO
DeForest Richards	eb78dea	2019-09-29 15:31:52 +0000	[diff] [blame]	31
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	32	API Reference
				33	-------------
				34
				35	`Doxygen generated documentation <http://llvm.org/doxygen/>`_
				36	(`classes <http://llvm.org/doxygen/inherits.html>`_)
				37
				38	`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
				39
DeForest Richards	eb78dea	2019-09-29 15:31:52 +0000	[diff] [blame]	40	LLVM Reference
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	41	--------------
DeForest Richards	ccf6030	2019-09-25 00:49:02 +0000	[diff] [blame]	42
				43	:doc:`LLVM Language Reference Manual <LangRef>`
				44	Defines the LLVM intermediate representation and the assembly form of the
				45	different nodes.
				46
DeForest Richards	ccf6030	2019-09-25 00:49:02 +0000	[diff] [blame]	47	:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
				48	A reference manual for the MIR serialization format, which is used to test
				49	LLVM's code generation passes.
				50
DeForest Richards	de0e3aa	2019-10-06 16:10:11 +0000	[diff] [blame^]	51	:doc:`Atomics`
				52	Information about LLVM's concurrency model.
				53
				54	:doc:`CompilerWriterInfo`
				55	A list of helpful links for compiler writers.
				56
				57	:doc:`Extensions`
				58	LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
				59
				60	:doc:`HowToSetUpLLVMStyleRTTI`
				61	How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
				62	class hierarchy.
DeForest Richards	eb78dea	2019-09-29 15:31:52 +0000	[diff] [blame]	63
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	64	:doc:`GetElementPtr`
				65	Answers to some very frequent questions about LLVM's most frequently
				66	misunderstood instruction.
DeForest Richards	eb78dea	2019-09-29 15:31:52 +0000	[diff] [blame]	67
DeForest Richards	de0e3aa	2019-10-06 16:10:11 +0000	[diff] [blame^]	68	:doc:`ScudoHardenedAllocator`
				69	A library that implements a security-hardened `malloc()`.
				70
				71	:doc:`GwpAsan`
				72	A sampled heap memory error detection toolkit designed for production use.
				73
				74	:doc:`YamlIO`
				75	A reference guide for using LLVM's YAML I/O library.
				76
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	77	======================
				78	Command Line Utilities
				79	======================
DeForest Richards	eb78dea	2019-09-29 15:31:52 +0000	[diff] [blame]	80
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	81	:doc:`LLVM Command Guide <CommandGuide/index>`
				82	A reference manual for the LLVM command line utilities ("man" pages for LLVM
				83	tools).
DeForest Richards	ccf6030	2019-09-25 00:49:02 +0000	[diff] [blame]	84
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	85	:doc:`Bugpoint`
				86	Automatic bug finder and test-case reducer description and usage
				87	information.
				88
DeForest Richards	de0e3aa	2019-10-06 16:10:11 +0000	[diff] [blame^]	89	:doc:`OptBisect`
				90	A command line option for debugging optimization-induced failures.
				91
DeForest Richards	6d19651	2019-10-06 15:36:37 +0000	[diff] [blame]	92	:doc:`The Microsoft PDB File Format <PDB/index>`
				93	A detailed description of the Microsoft PDB (Program Database) file format.
				94
				95	==================
				96	Garbage Collection
				97	==================
				98
				99	:doc:`GarbageCollection`
				100	The interfaces source-language compilers should use for compiling GC'd
				101	programs.
				102
				103	:doc:`Statepoints`
				104	This describes a set of experimental extensions for garbage
				105	collection support.
				106
				107	=========
				108	LibFuzzer
				109	=========
				110
				111	:doc:`LibFuzzer`
				112	A library for writing in-process guided fuzzers.
				113
				114	:doc:`FuzzingLLVM`
				115	Information on writing and using Fuzzers to find bugs in LLVM.
				116
				117	=======
				118	Testing
				119	=======
				120
				121	:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
				122	A reference manual for using the LLVM testing infrastructure.
				123
				124	:doc:`TestSuiteGuide`
				125	Describes how to compile and run the test-suite benchmarks.