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

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