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

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