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

blob: 47c2f04739313d06df9b948e3a7b33d4d03e35ab [file] [log] [blame]

Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	1	Overview
				2	========
				3
				4	.. warning::
				5
				6	If you are using a released version of LLVM, see `the download page
				7	<http://llvm.org/releases/>`_ to find your documentation.
				8
				9	The LLVM compiler infrastructure supports a wide range of projects, from
				10	industrial strength compilers to specialized JIT applications to small
				11	research projects.
				12
				13	Similarly, documentation is broken down into several high-level groupings
Benjamin Kramer	bde9176	2012-06-02 10:20:22 +0000	[diff] [blame]	14	targeted at different audiences:
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	15
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	16	LLVM Design & Overview
				17	======================
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	18
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	19	Several introductory papers and presentations.
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	20
				21	.. toctree::
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	22	:hidden:
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	23
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	24	LangRef
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	25
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	26	:doc:`LangRef`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	27	Defines the LLVM intermediate representation.
				28
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	29	`Introduction to the LLVM Compiler`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	30	Presentation providing a users introduction to LLVM.
				31
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	32	.. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	33
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	34	`Intro to LLVM`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	35	Book chapter providing a compiler hacker's introduction to LLVM.
				36
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	37	.. __: http://www.aosabook.org/en/llvm.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	38
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	39
				40	`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	41	Design overview.
				42
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	43	.. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	44
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	45	`LLVM: An Infrastructure for Multi-Stage Optimization`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	46	More details (quite old now).
				47
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	48	.. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	49
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	50	`Publications mentioning LLVM <http://llvm.org/pubs>`_
				51	..
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	52
				53	User Guides
				54	===========
				55
				56	For those new to the LLVM system.
				57
				58	NOTE: If you are a user who is only interested in using LLVM-based
				59	compilers, you should look into `Clang <http://clang.llvm.org>`_ or
				60	`DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
				61	intended for users who have a need to work with the intermediate LLVM
				62	representation.
				63
				64	.. toctree::
				65	:hidden:
				66
				67	CMake
Chris Bieneman	9debb98	2016-04-29 20:34:54 +0000	[diff] [blame]	68	CMakePrimer
Chris Bieneman	ebb1dd9	2016-03-18 21:57:51 +0000	[diff] [blame]	69	AdvancedBuilds
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	70	HowToBuildOnARM
Peter Smith	7411da5	2017-11-07 09:40:05 +0000	[diff] [blame^]	71	HowToCrossCompileBuiltinsOnArm
Renato Golin	d24899b	2013-09-08 20:44:48 +0000	[diff] [blame]	72	HowToCrossCompileLLVM
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	73	CommandGuide/index
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	74	GettingStarted
				75	GettingStartedVS
				76	FAQ
				77	Lexicon
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	78	HowToAddABuilder
				79	yaml2obj
				80	HowToSubmitABug
				81	SphinxQuickstartTemplate
				82	Phabricator
				83	TestingGuide
				84	tutorial/index
				85	ReleaseNotes
				86	Passes
				87	YamlIO
Sean Silva	163b5c4	2013-03-30 15:32:50 +0000	[diff] [blame]	88	GetElementPtr
Philip Reames	f8bf9dd	2015-02-27 23:14:50 +0000	[diff] [blame]	89	Frontend/PerformanceTips
Sean Silva	3f93a61	2013-09-09 19:09:00 +0000	[diff] [blame]	90	MCJITDesignAndImplementation
Chandler Carruth	3629343	2016-06-30 20:27:54 +0000	[diff] [blame]	91	CodeOfConduct
Jingyue Wu	4f2a6cb	2015-11-10 22:35:47 +0000	[diff] [blame]	92	CompileCudaWithLLVM
Chandler Carruth	3629343	2016-06-30 20:27:54 +0000	[diff] [blame]	93	ReportingGuide
Rafael Espindola	50a1739	2017-05-24 16:39:12 +0000	[diff] [blame]	94	Benchmarking
Ilya Biryukov	af351da	2017-06-30 09:46:45 +0000	[diff] [blame]	95	Docker
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	96
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	97	:doc:`GettingStarted`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	98	Discusses how to get up and running quickly with the LLVM infrastructure.
				99	Everything from unpacking and compilation of the distribution to execution
				100	of some tools.
				101
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	102	:doc:`CMake`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	103	An addendum to the main Getting Started guide for those using the `CMake
				104	build system <http://www.cmake.org>`_.
				105
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	106	:doc:`HowToBuildOnARM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	107	Notes on building and testing LLVM/Clang on ARM.
				108
Peter Smith	7411da5	2017-11-07 09:40:05 +0000	[diff] [blame^]	109	:doc:`HowToCrossCompileBuiltinsOnArm`
				110	Notes on cross-building and testing the compiler-rt builtins for Arm.
				111
Renato Golin	d24899b	2013-09-08 20:44:48 +0000	[diff] [blame]	112	:doc:`HowToCrossCompileLLVM`
				113	Notes on cross-building and testing LLVM/Clang.
				114
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	115	:doc:`GettingStartedVS`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	116	An addendum to the main Getting Started guide for those using Visual Studio
				117	on Windows.
				118
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	119	:doc:`tutorial/index`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	120	Tutorials about using LLVM. Includes a tutorial about making a custom
				121	language with LLVM.
				122
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	123	:doc:`LLVM Command Guide <CommandGuide/index>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	124	A reference manual for the LLVM command line utilities ("man" pages for LLVM
				125	tools).
				126
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	127	:doc:`Passes`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	128	A list of optimizations and analyses implemented in LLVM.
				129
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	130	:doc:`FAQ`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	131	A list of common questions and problems and their solutions.
				132
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	133	:doc:`Release notes for the current release <ReleaseNotes>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	134	This describes new features, known bugs, and other limitations.
				135
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	136	:doc:`HowToSubmitABug`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	137	Instructions for properly submitting information about any bugs you run into
				138	in the LLVM system.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	139
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	140	:doc:`SphinxQuickstartTemplate`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	141	A template + tutorial for writing new Sphinx documentation. It is meant
				142	to be read in source form.
				143
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	144	:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	145	A reference manual for using the LLVM testing infrastructure.
				146
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	147	`How to build the C, C++, ObjC, and ObjC++ front end`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	148	Instructions for building the clang front-end from source.
				149
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	150	.. __: http://clang.llvm.org/get_started.html
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	151
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	152	:doc:`Lexicon`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	153	Definition of acronyms, terms and concepts used in LLVM.
				154
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	155	:doc:`HowToAddABuilder`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	156	Instructions for adding new builder to LLVM buildbot master.
				157
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	158	:doc:`YamlIO`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	159	A reference guide for using LLVM's YAML I/O library.
				160
Sean Silva	163b5c4	2013-03-30 15:32:50 +0000	[diff] [blame]	161	:doc:`GetElementPtr`
				162	Answers to some very frequent questions about LLVM's most frequently
				163	misunderstood instruction.
				164
Philip Reames	f8bf9dd	2015-02-27 23:14:50 +0000	[diff] [blame]	165	:doc:`Frontend/PerformanceTips`
Vlad Tsyrklevich	31b4531	2017-09-20 20:38:14 +0000	[diff] [blame]	166	A collection of tips for frontend authors on how to generate IR
Philip Reames	f8bf9dd	2015-02-27 23:14:50 +0000	[diff] [blame]	167	which LLVM is able to effectively optimize.
				168
Ilya Biryukov	af351da	2017-06-30 09:46:45 +0000	[diff] [blame]	169	:doc:`Docker`
				170	A reference for using Dockerfiles provided with LLVM.
				171
Philip Reames	f8bf9dd	2015-02-27 23:14:50 +0000	[diff] [blame]	172
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	173	Programming Documentation
				174	=========================
				175
				176	For developers of applications which use LLVM as a library.
				177
				178	.. toctree::
				179	:hidden:
				180
				181	Atomics
				182	CodingStandards
				183	CommandLine
				184	CompilerWriterInfo
				185	ExtendingLLVM
				186	HowToSetUpLLVMStyleRTTI
				187	ProgrammersManual
Nico Rieck	1da4529	2013-04-10 23:28:17 +0000	[diff] [blame]	188	Extensions
Kostya Serebryany	35ce863	2015-03-30 23:05:30 +0000	[diff] [blame]	189	LibFuzzer
Justin Bogner	fd5b2a0	2017-10-12 01:44:24 +0000	[diff] [blame]	190	FuzzingLLVM
Kostya Serebryany	9a293ca	2016-06-07 23:13:54 +0000	[diff] [blame]	191	ScudoHardenedAllocator
Andrew Kaylor	3aeda4f	2016-08-26 23:11:48 +0000	[diff] [blame]	192	OptBisect
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	193
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	194	:doc:`LLVM Language Reference Manual <LangRef>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	195	Defines the LLVM intermediate representation and the assembly form of the
				196	different nodes.
				197
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	198	:doc:`Atomics`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	199	Information about LLVM's concurrency model.
				200
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	201	:doc:`ProgrammersManual`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	202	Introduction to the general layout of the LLVM sourcebase, important classes
				203	and APIs, and some tips & tricks.
				204
Nico Rieck	1da4529	2013-04-10 23:28:17 +0000	[diff] [blame]	205	:doc:`Extensions`
				206	LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
				207
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	208	:doc:`CommandLine`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	209	Provides information on using the command line parsing library.
				210
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	211	:doc:`CodingStandards`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	212	Details the LLVM coding standards and provides useful information on writing
				213	efficient C++ code.
				214
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	215	:doc:`HowToSetUpLLVMStyleRTTI`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	216	How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
				217	class hierarchy.
				218
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	219	:doc:`ExtendingLLVM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	220	Look here to see how to add instructions and intrinsics to LLVM.
				221
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	222	`Doxygen generated documentation <http://llvm.org/doxygen/>`_
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	223	(`classes <http://llvm.org/doxygen/inherits.html>`_)
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	224
Peter Collingbourne	943d270	2015-01-13 18:49:42 +0000	[diff] [blame]	225	`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
				226
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	227	`ViewVC Repository Browser <http://llvm.org/viewvc/>`_
				228	..
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	229
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	230	:doc:`CompilerWriterInfo`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	231	A list of helpful links for compiler writers.
				232
Kostya Serebryany	35ce863	2015-03-30 23:05:30 +0000	[diff] [blame]	233	:doc:`LibFuzzer`
				234	A library for writing in-process guided fuzzers.
				235
Justin Bogner	fd5b2a0	2017-10-12 01:44:24 +0000	[diff] [blame]	236	:doc:`FuzzingLLVM`
				237	Information on writing and using Fuzzers to find bugs in LLVM.
				238
Kostya Serebryany	9a293ca	2016-06-07 23:13:54 +0000	[diff] [blame]	239	:doc:`ScudoHardenedAllocator`
				240	A library that implements a security-hardened `malloc()`.
				241
Andrew Kaylor	3aeda4f	2016-08-26 23:11:48 +0000	[diff] [blame]	242	:doc:`OptBisect`
				243	A command line option for debugging optimization-induced failures.
				244
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	245	Subsystem Documentation
				246	=======================
				247
				248	For API clients and LLVM developers.
				249
				250	.. toctree::
				251	:hidden:
				252
				253	AliasAnalysis
George Burgess IV	3bbeb73	2016-08-17 00:17:29 +0000	[diff] [blame]	254	MemorySSA
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	255	BitCodeFormat
Duncan P. N. Exon Smith	6e40cec	2014-04-11 23:21:07 +0000	[diff] [blame]	256	BlockFrequencyTerminology
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	257	BranchWeightMetadata
				258	Bugpoint
				259	CodeGenerator
				260	ExceptionHandling
				261	LinkTimeOptimization
				262	SegmentedStacks
				263	TableGenFundamentals
Renato Golin	ca10564	2014-03-20 16:08:34 +0000	[diff] [blame]	264	TableGen/index
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	265	DebuggingJITedCode
				266	GoldPlugin
				267	MarkedUpDisassembly
				268	SystemLibrary
				269	SourceLevelDebugging
				270	Vectorizers
				271	WritingAnLLVMBackend
				272	GarbageCollection
				273	WritingAnLLVMPass
Joe Abbey	ba3e901	2013-02-12 11:45:22 +0000	[diff] [blame]	274	HowToUseAttributes
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	275	NVPTXUsage
Tom Stellard	45bb48e	2015-06-13 03:28:10 +0000	[diff] [blame]	276	AMDGPUUsage
Andrew Trick	5e029ce	2013-12-24 02:57:25 +0000	[diff] [blame]	277	StackMaps
Sean Silva	216f1ee	2014-03-02 00:21:42 +0000	[diff] [blame]	278	InAlloca
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	279	BigEndianNEON
Alex Lorenz	6a12833	2014-08-19 17:05:58 +0000	[diff] [blame]	280	CoverageMappingFormat
Matt Arsenault	03f0e83	2014-12-03 18:35:11 +0000	[diff] [blame]	281	Statepoints
Stepan Dyatkovskiy	f0c3a34	2014-12-10 17:42:01 +0000	[diff] [blame]	282	MergeFunctions
Peter Collingbourne	7efd750	2016-06-24 21:21:32 +0000	[diff] [blame]	283	TypeMetadata
Sanjoy Das	5553bc8	2015-06-15 19:38:15 +0000	[diff] [blame]	284	FaultMaps
Alex Lorenz	3d31177	2015-08-06 22:55:19 +0000	[diff] [blame]	285	MIRLangRef
David Majnemer	a653927	2016-07-23 04:05:08 +0000	[diff] [blame]	286	Coroutines
Ahmed Bougacha	29d9da1	2016-11-04 17:57:34 +0000	[diff] [blame]	287	GlobalISel
Dean Michael Berris	f3da16b	2016-11-09 00:24:58 +0000	[diff] [blame]	288	XRay
Dean Michael Berris	46979b4	2017-03-31 02:51:19 +0000	[diff] [blame]	289	XRayExample
Keith Wyss	3d0bc9e	2017-08-02 21:47:27 +0000	[diff] [blame]	290	XRayFDRFormat
Zachary Turner	218ce83	2016-11-10 19:24:21 +0000	[diff] [blame]	291	PDB/index
Vlad Tsyrklevich	31b4531	2017-09-20 20:38:14 +0000	[diff] [blame]	292	CFIVerify
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	293
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	294	:doc:`WritingAnLLVMPass`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	295	Information on how to write LLVM transformations and analyses.
				296
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	297	:doc:`WritingAnLLVMBackend`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	298	Information on how to write LLVM backends for machine targets.
				299
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	300	:doc:`CodeGenerator`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	301	The design and implementation of the LLVM code generator. Useful if you are
				302	working on retargetting LLVM to a new architecture, designing a new codegen
				303	pass, or enhancing existing components.
				304
Alex Lorenz	3d31177	2015-08-06 22:55:19 +0000	[diff] [blame]	305	:doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
				306	A reference manual for the MIR serialization format, which is used to test
				307	LLVM's code generation passes.
				308
Sean Silva	0b4df9b	2014-04-07 22:42:53 +0000	[diff] [blame]	309	:doc:`TableGen <TableGen/index>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	310	Describes the TableGen tool, which is used heavily by the LLVM code
				311	generator.
				312
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	313	:doc:`AliasAnalysis`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	314	Information on how to write a new alias analysis implementation or how to
				315	use existing analyses.
				316
George Burgess IV	3bbeb73	2016-08-17 00:17:29 +0000	[diff] [blame]	317	:doc:`MemorySSA`
				318	Information about the MemorySSA utility in LLVM, as well as how to use it.
				319
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	320	:doc:`GarbageCollection`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	321	The interfaces source-language compilers should use for compiling GC'd
				322	programs.
				323
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	324	:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	325	This document describes the design and philosophy behind the LLVM
				326	source-level debugger.
				327
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	328	:doc:`Vectorizers`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	329	This document describes the current status of vectorization in LLVM.
				330
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	331	:doc:`ExceptionHandling`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	332	This document describes the design and implementation of exception handling
				333	in LLVM.
				334
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	335	:doc:`Bugpoint`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	336	Automatic bug finder and test-case reducer description and usage
				337	information.
				338
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	339	:doc:`BitCodeFormat`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	340	This describes the file format and encoding used for LLVM "bc" files.
				341
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	342	:doc:`System Library <SystemLibrary>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	343	This document describes the LLVM System Library (``lib/System``) and
				344	how to keep LLVM source code portable
				345
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	346	:doc:`LinkTimeOptimization`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	347	This document describes the interface between LLVM intermodular optimizer
				348	and the linker and its design
				349
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	350	:doc:`GoldPlugin`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	351	How to build your programs with link-time optimization on Linux.
				352
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	353	:doc:`DebuggingJITedCode`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	354	How to debug JITed code with GDB.
				355
Andrew Kaylor	27299c3	2013-08-21 22:15:09 +0000	[diff] [blame]	356	:doc:`MCJITDesignAndImplementation`
				357	Describes the inner workings of MCJIT execution engine.
				358
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	359	:doc:`BranchWeightMetadata`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	360	Provides information about Branch Prediction Information.
				361
Duncan P. N. Exon Smith	6e40cec	2014-04-11 23:21:07 +0000	[diff] [blame]	362	:doc:`BlockFrequencyTerminology`
				363	Provides information about terminology used in the ``BlockFrequencyInfo``
				364	analysis pass.
				365
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	366	:doc:`SegmentedStacks`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	367	This document describes segmented stacks and how they are used in LLVM.
				368
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	369	:doc:`MarkedUpDisassembly`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	370	This document describes the optional rich disassembly output syntax.
				371
Joe Abbey	ba3e901	2013-02-12 11:45:22 +0000	[diff] [blame]	372	:doc:`HowToUseAttributes`
				373	Answers some questions about the new Attributes infrastructure.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	374
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	375	:doc:`NVPTXUsage`
Tony Tye	f16a45e	2017-06-06 20:31:59 +0000	[diff] [blame]	376	This document describes using the NVPTX backend to compile GPU kernels.
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	377
Tom Stellard	45bb48e	2015-06-13 03:28:10 +0000	[diff] [blame]	378	:doc:`AMDGPUUsage`
Tony Tye	f16a45e	2017-06-06 20:31:59 +0000	[diff] [blame]	379	This document describes using the AMDGPU backend to compile GPU kernels.
Tom Stellard	9d7ddd5	2014-11-14 14:08:00 +0000	[diff] [blame]	380
Andrew Trick	5e029ce	2013-12-24 02:57:25 +0000	[diff] [blame]	381	:doc:`StackMaps`
				382	LLVM support for mapping instruction addresses to the location of
				383	values and allowing code to be patched.
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	384
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	385	:doc:`BigEndianNEON`
				386	LLVM's support for generating NEON instructions on big endian ARM targets is
				387	somewhat nonintuitive. This document explains the implementation and rationale.
				388
Alex Lorenz	6a12833	2014-08-19 17:05:58 +0000	[diff] [blame]	389	:doc:`CoverageMappingFormat`
				390	This describes the format and encoding used for LLVM’s code coverage mapping.
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	391
Matt Arsenault	03f0e83	2014-12-03 18:35:11 +0000	[diff] [blame]	392	:doc:`Statepoints`
				393	This describes a set of experimental extensions for garbage
				394	collection support.
				395
Stepan Dyatkovskiy	f0c3a34	2014-12-10 17:42:01 +0000	[diff] [blame]	396	:doc:`MergeFunctions`
				397	Describes functions merging optimization.
				398
Sean Silva	b6472fe	2015-02-04 20:51:19 +0000	[diff] [blame]	399	:doc:`InAlloca`
				400	Description of the ``inalloca`` argument attribute.
				401
Sanjoy Das	5553bc8	2015-06-15 19:38:15 +0000	[diff] [blame]	402	:doc:`FaultMaps`
				403	LLVM support for folding control flow into faulting machine instructions.
				404
Jingyue Wu	4f2a6cb	2015-11-10 22:35:47 +0000	[diff] [blame]	405	:doc:`CompileCudaWithLLVM`
				406	LLVM support for CUDA.
				407
David Majnemer	a653927	2016-07-23 04:05:08 +0000	[diff] [blame]	408	:doc:`Coroutines`
				409	LLVM support for coroutines.
				410
Ahmed Bougacha	29d9da1	2016-11-04 17:57:34 +0000	[diff] [blame]	411	:doc:`GlobalISel`
				412	This describes the prototype instruction selection replacement, GlobalISel.
				413
Dean Michael Berris	f3da16b	2016-11-09 00:24:58 +0000	[diff] [blame]	414	:doc:`XRay`
				415	High-level documentation of how to use XRay in LLVM.
				416
Dean Michael Berris	38daca6	2017-03-30 23:46:36 +0000	[diff] [blame]	417	:doc:`XRayExample`
				418	An example of how to debug an application with XRay.
				419
Zachary Turner	218ce83	2016-11-10 19:24:21 +0000	[diff] [blame]	420	:doc:`The Microsoft PDB File Format <PDB/index>`
				421	A detailed description of the Microsoft PDB (Program Database) file format.
				422
Vlad Tsyrklevich	31b4531	2017-09-20 20:38:14 +0000	[diff] [blame]	423	:doc:`CFIVerify`
				424	A description of the verification tool for Control Flow Integrity.
				425
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	426	Development Process Documentation
				427	=================================
				428
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	429	Information about LLVM's development process.
				430
				431	.. toctree::
				432	:hidden:
				433
Sean Silva	9d205c8	2013-03-30 15:32:47 +0000	[diff] [blame]	434	DeveloperPolicy
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	435	Projects
				436	LLVMBuild
				437	HowToReleaseLLVM
Sean Silva	bdb940f	2013-01-28 21:28:10 +0000	[diff] [blame]	438	Packaging
Sean Silva	3f93a61	2013-09-09 19:09:00 +0000	[diff] [blame]	439	ReleaseProcess
Adrian Prantl	adc41ca	2014-10-03 20:17:32 +0000	[diff] [blame]	440	Phabricator
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	441
Sean Silva	9d205c8	2013-03-30 15:32:47 +0000	[diff] [blame]	442	:doc:`DeveloperPolicy`
				443	The LLVM project's policy towards developers and their contributions.
				444
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	445	:doc:`Projects`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	446	How-to guide and templates for new projects that use the LLVM
				447	infrastructure. The templates (directory organization, Makefiles, and test
				448	tree) allow the project code to be located outside (or inside) the ``llvm/``
				449	tree, while using LLVM header files and libraries.
				450
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	451	:doc:`LLVMBuild`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	452	Describes the LLVMBuild organization and files used by LLVM to specify
				453	component descriptions.
				454
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	455	:doc:`HowToReleaseLLVM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	456	This is a guide to preparing LLVM releases. Most developers can ignore it.
				457
Renato Golin	c08f218	2013-05-28 10:32:55 +0000	[diff] [blame]	458	:doc:`ReleaseProcess`
Jyoti Allur	223602d	2014-09-26 06:59:15 +0000	[diff] [blame]	459	This is a guide to validate a new release, during the release process. Most developers can ignore it.
Renato Golin	c08f218	2013-05-28 10:32:55 +0000	[diff] [blame]	460
Sean Silva	bdb940f	2013-01-28 21:28:10 +0000	[diff] [blame]	461	:doc:`Packaging`
				462	Advice on packaging LLVM into a distribution.
				463
Adrian Prantl	adc41ca	2014-10-03 20:17:32 +0000	[diff] [blame]	464	:doc:`Phabricator`
				465	Describes how to use the Phabricator code review tool hosted on
				466	http://reviews.llvm.org/ and its command line interface, Arcanist.
				467
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	468	Community
				469	=========
				470
				471	LLVM has a thriving community of friendly and helpful developers.
				472	The two primary communication mechanisms in the LLVM community are mailing
				473	lists and IRC.
				474
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	475	Mailing Lists
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	476	-------------
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	477
				478	If you can't find what you need in these docs, try consulting the mailing
				479	lists.
				480
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	481	`Developer's List (llvm-dev)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	482	This list is for people who want to be included in technical discussions of
				483	LLVM. People post to this list when they have questions about writing code
				484	for or using the LLVM tools. It is relatively low volume.
				485
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	486	.. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	487
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	488	`Commits Archive (llvm-commits)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	489	This list contains all commit messages that are made when LLVM developers
Sean Silva	2a74699	2013-03-30 15:33:02 +0000	[diff] [blame]	490	commit code changes to the repository. It also serves as a forum for
				491	patch review (i.e. send patches here). It is useful for those who want to
				492	stay on the bleeding edge of LLVM development. This list is very high
				493	volume.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	494
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	495	.. __: http://lists.llvm.org/pipermail/llvm-commits/
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	496
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	497	`Bugs & Patches Archive (llvm-bugs)`__
Sean Silva	2a74699	2013-03-30 15:33:02 +0000	[diff] [blame]	498	This list gets emailed every time a bug is opened and closed. It is
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	499	higher volume than the LLVM-dev list.
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	500
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	501	.. __: http://lists.llvm.org/pipermail/llvm-bugs/
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	502
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	503	`Test Results Archive (llvm-testresults)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	504	A message is automatically sent to this list by every active nightly tester
				505	when it completes. As such, this list gets email several times each day,
				506	making it a high volume list.
				507
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	508	.. __: http://lists.llvm.org/pipermail/llvm-testresults/
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	509
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	510	`LLVM Announcements List (llvm-announce)`__
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	511	This is a low volume list that provides important announcements regarding
				512	LLVM. It gets email about once a month.
				513
Tanya Lattner	0d28f80	2015-08-05 03:51:17 +0000	[diff] [blame]	514	.. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	515
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	516	IRC
				517	---
				518
				519	Users and developers of the LLVM project (including subprojects such as Clang)
				520	can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
				521
				522	This channel has several bots.
				523
				524	* Buildbot reporters
				525
				526	* llvmbb - Bot for the main LLVM buildbot master.
				527	http://lab.llvm.org:8011/console
				528	* bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
				529	* smooshlab - Apple's internal buildbot master.
				530
				531	* robot - Bugzilla linker. %bug <number>
				532
				533	* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
				534	near-trunk clang instead of gcc.
				535
Renato Golin	e433cf7	2016-07-20 09:38:04 +0000	[diff] [blame]	536	Community wide proposals
				537	------------------------
				538
				539	Proposals for massive changes in how the community behaves and how the work flow
				540	can be better.
				541
				542	.. toctree::
				543	:hidden:
				544
				545	CodeOfConduct
Mehdi Amini	647deb8	2016-10-12 23:02:02 +0000	[diff] [blame]	546	Proposals/GitHubMove
Ayal Zaks	4c4baf5	2017-05-29 15:36:23 +0000	[diff] [blame]	547	Proposals/VectorizationPlan
Renato Golin	e433cf7	2016-07-20 09:38:04 +0000	[diff] [blame]	548
				549	:doc:`CodeOfConduct`
				550	Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
				551	IRC, etc).
				552
Mehdi Amini	647deb8	2016-10-12 23:02:02 +0000	[diff] [blame]	553	:doc:`Proposals/GitHubMove`
Renato Golin	e433cf7	2016-07-20 09:38:04 +0000	[diff] [blame]	554	Proposal to move from SVN/Git to GitHub.
				555
Ayal Zaks	4c4baf5	2017-05-29 15:36:23 +0000	[diff] [blame]	556	:doc:`Proposals/VectorizationPlan`
				557	Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	558
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	559	Indices and tables
				560	==================
				561
				562	* :ref:`genindex`
				563	* :ref:`search`