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

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