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

blob: 2cc5b8bf095780ee34a9897133451f806010067f [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
				68	HowToBuildOnARM
Renato Golin	d24899b	2013-09-08 20:44:48 +0000	[diff] [blame]	69	HowToCrossCompileLLVM
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	70	CommandGuide/index
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	71	GettingStarted
				72	GettingStartedVS
Chris Bieneman	9f611e3	2015-03-13 01:58:14 +0000	[diff] [blame]	73	BuildingLLVMWithAutotools
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	74	FAQ
				75	Lexicon
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	76	HowToAddABuilder
				77	yaml2obj
				78	HowToSubmitABug
				79	SphinxQuickstartTemplate
				80	Phabricator
				81	TestingGuide
				82	tutorial/index
				83	ReleaseNotes
				84	Passes
				85	YamlIO
Sean Silva	163b5c4	2013-03-30 15:32:50 +0000	[diff] [blame]	86	GetElementPtr
Philip Reames	f8bf9dd	2015-02-27 23:14:50 +0000	[diff] [blame]	87	Frontend/PerformanceTips
Sean Silva	3f93a61	2013-09-09 19:09:00 +0000	[diff] [blame]	88	MCJITDesignAndImplementation
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	89
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	90	:doc:`GettingStarted`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	91	Discusses how to get up and running quickly with the LLVM infrastructure.
				92	Everything from unpacking and compilation of the distribution to execution
				93	of some tools.
				94
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	95	:doc:`CMake`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	96	An addendum to the main Getting Started guide for those using the `CMake
				97	build system <http://www.cmake.org>`_.
				98
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	99	:doc:`HowToBuildOnARM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	100	Notes on building and testing LLVM/Clang on ARM.
				101
Renato Golin	d24899b	2013-09-08 20:44:48 +0000	[diff] [blame]	102	:doc:`HowToCrossCompileLLVM`
				103	Notes on cross-building and testing LLVM/Clang.
				104
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	105	:doc:`GettingStartedVS`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	106	An addendum to the main Getting Started guide for those using Visual Studio
				107	on Windows.
				108
Chris Bieneman	9f611e3	2015-03-13 01:58:14 +0000	[diff] [blame]	109	:doc:`BuildingLLVMWithAutotools`
				110	An addendum to the Getting Started guide with instructions for building LLVM
				111	with the Autotools build system.
				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
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	181
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	182	:doc:`LLVM Language Reference Manual <LangRef>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	183	Defines the LLVM intermediate representation and the assembly form of the
				184	different nodes.
				185
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	186	:doc:`Atomics`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	187	Information about LLVM's concurrency model.
				188
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	189	:doc:`ProgrammersManual`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	190	Introduction to the general layout of the LLVM sourcebase, important classes
				191	and APIs, and some tips & tricks.
				192
Nico Rieck	1da4529	2013-04-10 23:28:17 +0000	[diff] [blame]	193	:doc:`Extensions`
				194	LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
				195
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	196	:doc:`CommandLine`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	197	Provides information on using the command line parsing library.
				198
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	199	:doc:`CodingStandards`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	200	Details the LLVM coding standards and provides useful information on writing
				201	efficient C++ code.
				202
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	203	:doc:`HowToSetUpLLVMStyleRTTI`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	204	How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
				205	class hierarchy.
				206
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	207	:doc:`ExtendingLLVM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	208	Look here to see how to add instructions and intrinsics to LLVM.
				209
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	210	`Doxygen generated documentation <http://llvm.org/doxygen/>`_
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	211	(`classes <http://llvm.org/doxygen/inherits.html>`_)
				212	(`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
				213
Peter Collingbourne	943d270	2015-01-13 18:49:42 +0000	[diff] [blame]	214	`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
				215
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	216	`ViewVC Repository Browser <http://llvm.org/viewvc/>`_
				217	..
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	218
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	219	:doc:`CompilerWriterInfo`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	220	A list of helpful links for compiler writers.
				221
Kostya Serebryany	35ce863	2015-03-30 23:05:30 +0000	[diff] [blame^]	222	:doc:`LibFuzzer`
				223	A library for writing in-process guided fuzzers.
				224
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	225	Subsystem Documentation
				226	=======================
				227
				228	For API clients and LLVM developers.
				229
				230	.. toctree::
				231	:hidden:
				232
				233	AliasAnalysis
				234	BitCodeFormat
Duncan P. N. Exon Smith	6e40cec	2014-04-11 23:21:07 +0000	[diff] [blame]	235	BlockFrequencyTerminology
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	236	BranchWeightMetadata
				237	Bugpoint
				238	CodeGenerator
				239	ExceptionHandling
				240	LinkTimeOptimization
				241	SegmentedStacks
				242	TableGenFundamentals
Renato Golin	ca10564	2014-03-20 16:08:34 +0000	[diff] [blame]	243	TableGen/index
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	244	DebuggingJITedCode
				245	GoldPlugin
				246	MarkedUpDisassembly
				247	SystemLibrary
				248	SourceLevelDebugging
				249	Vectorizers
				250	WritingAnLLVMBackend
				251	GarbageCollection
				252	WritingAnLLVMPass
Joe Abbey	ba3e901	2013-02-12 11:45:22 +0000	[diff] [blame]	253	HowToUseAttributes
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	254	NVPTXUsage
Tom Stellard	9d7ddd5	2014-11-14 14:08:00 +0000	[diff] [blame]	255	R600Usage
Andrew Trick	5e029ce	2013-12-24 02:57:25 +0000	[diff] [blame]	256	StackMaps
Sean Silva	216f1ee	2014-03-02 00:21:42 +0000	[diff] [blame]	257	InAlloca
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	258	BigEndianNEON
Alex Lorenz	6a12833	2014-08-19 17:05:58 +0000	[diff] [blame]	259	CoverageMappingFormat
Matt Arsenault	03f0e83	2014-12-03 18:35:11 +0000	[diff] [blame]	260	Statepoints
Stepan Dyatkovskiy	f0c3a34	2014-12-10 17:42:01 +0000	[diff] [blame]	261	MergeFunctions
Peter Collingbourne	e6909c8	2015-02-20 20:30:47 +0000	[diff] [blame]	262	BitSets
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	263
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	264	:doc:`WritingAnLLVMPass`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	265	Information on how to write LLVM transformations and analyses.
				266
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	267	:doc:`WritingAnLLVMBackend`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	268	Information on how to write LLVM backends for machine targets.
				269
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	270	:doc:`CodeGenerator`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	271	The design and implementation of the LLVM code generator. Useful if you are
				272	working on retargetting LLVM to a new architecture, designing a new codegen
				273	pass, or enhancing existing components.
				274
Sean Silva	0b4df9b	2014-04-07 22:42:53 +0000	[diff] [blame]	275	:doc:`TableGen <TableGen/index>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	276	Describes the TableGen tool, which is used heavily by the LLVM code
				277	generator.
				278
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	279	:doc:`AliasAnalysis`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	280	Information on how to write a new alias analysis implementation or how to
				281	use existing analyses.
				282
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	283	:doc:`GarbageCollection`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	284	The interfaces source-language compilers should use for compiling GC'd
				285	programs.
				286
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	287	:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	288	This document describes the design and philosophy behind the LLVM
				289	source-level debugger.
				290
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	291	:doc:`Vectorizers`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	292	This document describes the current status of vectorization in LLVM.
				293
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	294	:doc:`ExceptionHandling`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	295	This document describes the design and implementation of exception handling
				296	in LLVM.
				297
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	298	:doc:`Bugpoint`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	299	Automatic bug finder and test-case reducer description and usage
				300	information.
				301
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	302	:doc:`BitCodeFormat`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	303	This describes the file format and encoding used for LLVM "bc" files.
				304
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	305	:doc:`System Library <SystemLibrary>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	306	This document describes the LLVM System Library (``lib/System``) and
				307	how to keep LLVM source code portable
				308
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	309	:doc:`LinkTimeOptimization`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	310	This document describes the interface between LLVM intermodular optimizer
				311	and the linker and its design
				312
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	313	:doc:`GoldPlugin`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	314	How to build your programs with link-time optimization on Linux.
				315
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	316	:doc:`DebuggingJITedCode`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	317	How to debug JITed code with GDB.
				318
Andrew Kaylor	27299c3	2013-08-21 22:15:09 +0000	[diff] [blame]	319	:doc:`MCJITDesignAndImplementation`
				320	Describes the inner workings of MCJIT execution engine.
				321
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	322	:doc:`BranchWeightMetadata`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	323	Provides information about Branch Prediction Information.
				324
Duncan P. N. Exon Smith	6e40cec	2014-04-11 23:21:07 +0000	[diff] [blame]	325	:doc:`BlockFrequencyTerminology`
				326	Provides information about terminology used in the ``BlockFrequencyInfo``
				327	analysis pass.
				328
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	329	:doc:`SegmentedStacks`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	330	This document describes segmented stacks and how they are used in LLVM.
				331
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	332	:doc:`MarkedUpDisassembly`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	333	This document describes the optional rich disassembly output syntax.
				334
Joe Abbey	ba3e901	2013-02-12 11:45:22 +0000	[diff] [blame]	335	:doc:`HowToUseAttributes`
				336	Answers some questions about the new Attributes infrastructure.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	337
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	338	:doc:`NVPTXUsage`
				339	This document describes using the NVPTX back-end to compile GPU kernels.
				340
Tom Stellard	9d7ddd5	2014-11-14 14:08:00 +0000	[diff] [blame]	341	:doc:`R600Usage`
				342	This document describes how to use the R600 back-end.
				343
Andrew Trick	5e029ce	2013-12-24 02:57:25 +0000	[diff] [blame]	344	:doc:`StackMaps`
				345	LLVM support for mapping instruction addresses to the location of
				346	values and allowing code to be patched.
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	347
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	348	:doc:`BigEndianNEON`
				349	LLVM's support for generating NEON instructions on big endian ARM targets is
				350	somewhat nonintuitive. This document explains the implementation and rationale.
				351
Alex Lorenz	6a12833	2014-08-19 17:05:58 +0000	[diff] [blame]	352	:doc:`CoverageMappingFormat`
				353	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]	354
Matt Arsenault	03f0e83	2014-12-03 18:35:11 +0000	[diff] [blame]	355	:doc:`Statepoints`
				356	This describes a set of experimental extensions for garbage
				357	collection support.
				358
Stepan Dyatkovskiy	f0c3a34	2014-12-10 17:42:01 +0000	[diff] [blame]	359	:doc:`MergeFunctions`
				360	Describes functions merging optimization.
				361
Sean Silva	b6472fe	2015-02-04 20:51:19 +0000	[diff] [blame]	362	:doc:`InAlloca`
				363	Description of the ``inalloca`` argument attribute.
				364
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	365	Development Process Documentation
				366	=================================
				367
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	368	Information about LLVM's development process.
				369
				370	.. toctree::
				371	:hidden:
				372
Sean Silva	9d205c8	2013-03-30 15:32:47 +0000	[diff] [blame]	373	DeveloperPolicy
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	374	MakefileGuide
				375	Projects
				376	LLVMBuild
				377	HowToReleaseLLVM
Sean Silva	bdb940f	2013-01-28 21:28:10 +0000	[diff] [blame]	378	Packaging
Sean Silva	3f93a61	2013-09-09 19:09:00 +0000	[diff] [blame]	379	ReleaseProcess
Adrian Prantl	adc41ca	2014-10-03 20:17:32 +0000	[diff] [blame]	380	Phabricator
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	381
Sean Silva	9d205c8	2013-03-30 15:32:47 +0000	[diff] [blame]	382	:doc:`DeveloperPolicy`
				383	The LLVM project's policy towards developers and their contributions.
				384
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	385	:doc:`Projects`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	386	How-to guide and templates for new projects that use the LLVM
				387	infrastructure. The templates (directory organization, Makefiles, and test
				388	tree) allow the project code to be located outside (or inside) the ``llvm/``
				389	tree, while using LLVM header files and libraries.
				390
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	391	:doc:`LLVMBuild`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	392	Describes the LLVMBuild organization and files used by LLVM to specify
				393	component descriptions.
				394
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	395	:doc:`MakefileGuide`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	396	Describes how the LLVM makefiles work and how to use them.
				397
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	398	:doc:`HowToReleaseLLVM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	399	This is a guide to preparing LLVM releases. Most developers can ignore it.
				400
Renato Golin	c08f218	2013-05-28 10:32:55 +0000	[diff] [blame]	401	:doc:`ReleaseProcess`
Jyoti Allur	223602d	2014-09-26 06:59:15 +0000	[diff] [blame]	402	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]	403
Sean Silva	bdb940f	2013-01-28 21:28:10 +0000	[diff] [blame]	404	:doc:`Packaging`
				405	Advice on packaging LLVM into a distribution.
				406
Adrian Prantl	adc41ca	2014-10-03 20:17:32 +0000	[diff] [blame]	407	:doc:`Phabricator`
				408	Describes how to use the Phabricator code review tool hosted on
				409	http://reviews.llvm.org/ and its command line interface, Arcanist.
				410
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	411	Community
				412	=========
				413
				414	LLVM has a thriving community of friendly and helpful developers.
				415	The two primary communication mechanisms in the LLVM community are mailing
				416	lists and IRC.
				417
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	418	Mailing Lists
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	419	-------------
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	420
				421	If you can't find what you need in these docs, try consulting the mailing
				422	lists.
				423
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	424	`Developer's List (llvmdev)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	425	This list is for people who want to be included in technical discussions of
				426	LLVM. People post to this list when they have questions about writing code
				427	for or using the LLVM tools. It is relatively low volume.
				428
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	429	.. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	430
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	431	`Commits Archive (llvm-commits)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	432	This list contains all commit messages that are made when LLVM developers
Sean Silva	2a74699	2013-03-30 15:33:02 +0000	[diff] [blame]	433	commit code changes to the repository. It also serves as a forum for
				434	patch review (i.e. send patches here). It is useful for those who want to
				435	stay on the bleeding edge of LLVM development. This list is very high
				436	volume.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	437
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	438	.. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	439
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	440	`Bugs & Patches Archive (llvmbugs)`__
Sean Silva	2a74699	2013-03-30 15:33:02 +0000	[diff] [blame]	441	This list gets emailed every time a bug is opened and closed. It is
				442	higher volume than the LLVMdev list.
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	443
				444	.. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
				445
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	446	`Test Results Archive (llvm-testresults)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	447	A message is automatically sent to this list by every active nightly tester
				448	when it completes. As such, this list gets email several times each day,
				449	making it a high volume list.
				450
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	451	.. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
				452
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	453	`LLVM Announcements List (llvm-announce)`__
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	454	This is a low volume list that provides important announcements regarding
				455	LLVM. It gets email about once a month.
				456
				457	.. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
				458
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	459	IRC
				460	---
				461
				462	Users and developers of the LLVM project (including subprojects such as Clang)
				463	can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
				464
				465	This channel has several bots.
				466
				467	* Buildbot reporters
				468
				469	* llvmbb - Bot for the main LLVM buildbot master.
				470	http://lab.llvm.org:8011/console
				471	* bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
				472	* smooshlab - Apple's internal buildbot master.
				473
				474	* robot - Bugzilla linker. %bug <number>
				475
				476	* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
				477	near-trunk clang instead of gcc.
				478
				479
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	480	Indices and tables
				481	==================
				482
				483	* :ref:`genindex`
				484	* :ref:`search`