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

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