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

blob: dd6ea18f090630a8a1df89e1c5a961304459a327 [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
Peter Collingbourne	943d270	2015-01-13 18:49:42 +0000	[diff] [blame]	202	`Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
				203
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	204	`ViewVC Repository Browser <http://llvm.org/viewvc/>`_
				205	..
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	206
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	207	:doc:`CompilerWriterInfo`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	208	A list of helpful links for compiler writers.
				209
				210	Subsystem Documentation
				211	=======================
				212
				213	For API clients and LLVM developers.
				214
				215	.. toctree::
				216	:hidden:
				217
				218	AliasAnalysis
				219	BitCodeFormat
Duncan P. N. Exon Smith	6e40cec	2014-04-11 23:21:07 +0000	[diff] [blame]	220	BlockFrequencyTerminology
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	221	BranchWeightMetadata
				222	Bugpoint
				223	CodeGenerator
				224	ExceptionHandling
				225	LinkTimeOptimization
				226	SegmentedStacks
				227	TableGenFundamentals
Renato Golin	ca10564	2014-03-20 16:08:34 +0000	[diff] [blame]	228	TableGen/index
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	229	DebuggingJITedCode
				230	GoldPlugin
				231	MarkedUpDisassembly
				232	SystemLibrary
				233	SourceLevelDebugging
				234	Vectorizers
				235	WritingAnLLVMBackend
				236	GarbageCollection
				237	WritingAnLLVMPass
Joe Abbey	ba3e901	2013-02-12 11:45:22 +0000	[diff] [blame]	238	HowToUseAttributes
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	239	NVPTXUsage
Tom Stellard	9d7ddd5	2014-11-14 14:08:00 +0000	[diff] [blame]	240	R600Usage
Andrew Trick	5e029ce	2013-12-24 02:57:25 +0000	[diff] [blame]	241	StackMaps
Sean Silva	216f1ee	2014-03-02 00:21:42 +0000	[diff] [blame]	242	InAlloca
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	243	BigEndianNEON
Alex Lorenz	6a12833	2014-08-19 17:05:58 +0000	[diff] [blame]	244	CoverageMappingFormat
Matt Arsenault	03f0e83	2014-12-03 18:35:11 +0000	[diff] [blame]	245	Statepoints
Stepan Dyatkovskiy	f0c3a34	2014-12-10 17:42:01 +0000	[diff] [blame]	246	MergeFunctions
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	247
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	248	:doc:`WritingAnLLVMPass`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	249	Information on how to write LLVM transformations and analyses.
				250
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	251	:doc:`WritingAnLLVMBackend`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	252	Information on how to write LLVM backends for machine targets.
				253
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	254	:doc:`CodeGenerator`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	255	The design and implementation of the LLVM code generator. Useful if you are
				256	working on retargetting LLVM to a new architecture, designing a new codegen
				257	pass, or enhancing existing components.
				258
Sean Silva	0b4df9b	2014-04-07 22:42:53 +0000	[diff] [blame]	259	:doc:`TableGen <TableGen/index>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	260	Describes the TableGen tool, which is used heavily by the LLVM code
				261	generator.
				262
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	263	:doc:`AliasAnalysis`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	264	Information on how to write a new alias analysis implementation or how to
				265	use existing analyses.
				266
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	267	:doc:`GarbageCollection`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	268	The interfaces source-language compilers should use for compiling GC'd
				269	programs.
				270
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	271	:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	272	This document describes the design and philosophy behind the LLVM
				273	source-level debugger.
				274
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	275	:doc:`Vectorizers`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	276	This document describes the current status of vectorization in LLVM.
				277
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	278	:doc:`ExceptionHandling`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	279	This document describes the design and implementation of exception handling
				280	in LLVM.
				281
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	282	:doc:`Bugpoint`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	283	Automatic bug finder and test-case reducer description and usage
				284	information.
				285
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	286	:doc:`BitCodeFormat`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	287	This describes the file format and encoding used for LLVM "bc" files.
				288
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	289	:doc:`System Library <SystemLibrary>`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	290	This document describes the LLVM System Library (``lib/System``) and
				291	how to keep LLVM source code portable
				292
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	293	:doc:`LinkTimeOptimization`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	294	This document describes the interface between LLVM intermodular optimizer
				295	and the linker and its design
				296
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	297	:doc:`GoldPlugin`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	298	How to build your programs with link-time optimization on Linux.
				299
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	300	:doc:`DebuggingJITedCode`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	301	How to debug JITed code with GDB.
				302
Andrew Kaylor	27299c3	2013-08-21 22:15:09 +0000	[diff] [blame]	303	:doc:`MCJITDesignAndImplementation`
				304	Describes the inner workings of MCJIT execution engine.
				305
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	306	:doc:`BranchWeightMetadata`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	307	Provides information about Branch Prediction Information.
				308
Duncan P. N. Exon Smith	6e40cec	2014-04-11 23:21:07 +0000	[diff] [blame]	309	:doc:`BlockFrequencyTerminology`
				310	Provides information about terminology used in the ``BlockFrequencyInfo``
				311	analysis pass.
				312
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	313	:doc:`SegmentedStacks`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	314	This document describes segmented stacks and how they are used in LLVM.
				315
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	316	:doc:`MarkedUpDisassembly`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	317	This document describes the optional rich disassembly output syntax.
				318
Joe Abbey	ba3e901	2013-02-12 11:45:22 +0000	[diff] [blame]	319	:doc:`HowToUseAttributes`
				320	Answers some questions about the new Attributes infrastructure.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	321
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	322	:doc:`NVPTXUsage`
				323	This document describes using the NVPTX back-end to compile GPU kernels.
				324
Tom Stellard	9d7ddd5	2014-11-14 14:08:00 +0000	[diff] [blame]	325	:doc:`R600Usage`
				326	This document describes how to use the R600 back-end.
				327
Andrew Trick	5e029ce	2013-12-24 02:57:25 +0000	[diff] [blame]	328	:doc:`StackMaps`
				329	LLVM support for mapping instruction addresses to the location of
				330	values and allowing code to be patched.
Justin Holewinski	45df882	2013-03-30 16:41:14 +0000	[diff] [blame]	331
James Molloy	3f7878a	2014-05-12 15:13:39 +0000	[diff] [blame]	332	:doc:`BigEndianNEON`
				333	LLVM's support for generating NEON instructions on big endian ARM targets is
				334	somewhat nonintuitive. This document explains the implementation and rationale.
				335
Alex Lorenz	6a12833	2014-08-19 17:05:58 +0000	[diff] [blame]	336	:doc:`CoverageMappingFormat`
				337	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]	338
Matt Arsenault	03f0e83	2014-12-03 18:35:11 +0000	[diff] [blame]	339	:doc:`Statepoints`
				340	This describes a set of experimental extensions for garbage
				341	collection support.
				342
Stepan Dyatkovskiy	f0c3a34	2014-12-10 17:42:01 +0000	[diff] [blame]	343	:doc:`MergeFunctions`
				344	Describes functions merging optimization.
				345
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	346	Development Process Documentation
				347	=================================
				348
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	349	Information about LLVM's development process.
				350
				351	.. toctree::
				352	:hidden:
				353
Sean Silva	9d205c8	2013-03-30 15:32:47 +0000	[diff] [blame]	354	DeveloperPolicy
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	355	MakefileGuide
				356	Projects
				357	LLVMBuild
				358	HowToReleaseLLVM
Sean Silva	bdb940f	2013-01-28 21:28:10 +0000	[diff] [blame]	359	Packaging
Sean Silva	3f93a61	2013-09-09 19:09:00 +0000	[diff] [blame]	360	ReleaseProcess
Adrian Prantl	adc41ca	2014-10-03 20:17:32 +0000	[diff] [blame]	361	Phabricator
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	362
Sean Silva	9d205c8	2013-03-30 15:32:47 +0000	[diff] [blame]	363	:doc:`DeveloperPolicy`
				364	The LLVM project's policy towards developers and their contributions.
				365
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	366	:doc:`Projects`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	367	How-to guide and templates for new projects that use the LLVM
				368	infrastructure. The templates (directory organization, Makefiles, and test
				369	tree) allow the project code to be located outside (or inside) the ``llvm/``
				370	tree, while using LLVM header files and libraries.
				371
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	372	:doc:`LLVMBuild`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	373	Describes the LLVMBuild organization and files used by LLVM to specify
				374	component descriptions.
				375
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	376	:doc:`MakefileGuide`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	377	Describes how the LLVM makefiles work and how to use them.
				378
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	379	:doc:`HowToReleaseLLVM`
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	380	This is a guide to preparing LLVM releases. Most developers can ignore it.
				381
Renato Golin	c08f218	2013-05-28 10:32:55 +0000	[diff] [blame]	382	:doc:`ReleaseProcess`
Jyoti Allur	223602d	2014-09-26 06:59:15 +0000	[diff] [blame]	383	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]	384
Sean Silva	bdb940f	2013-01-28 21:28:10 +0000	[diff] [blame]	385	:doc:`Packaging`
				386	Advice on packaging LLVM into a distribution.
				387
Adrian Prantl	adc41ca	2014-10-03 20:17:32 +0000	[diff] [blame]	388	:doc:`Phabricator`
				389	Describes how to use the Phabricator code review tool hosted on
				390	http://reviews.llvm.org/ and its command line interface, Arcanist.
				391
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	392	Community
				393	=========
				394
				395	LLVM has a thriving community of friendly and helpful developers.
				396	The two primary communication mechanisms in the LLVM community are mailing
				397	lists and IRC.
				398
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	399	Mailing Lists
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	400	-------------
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	401
				402	If you can't find what you need in these docs, try consulting the mailing
				403	lists.
				404
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	405	`Developer's List (llvmdev)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	406	This list is for people who want to be included in technical discussions of
				407	LLVM. People post to this list when they have questions about writing code
				408	for or using the LLVM tools. It is relatively low volume.
				409
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	410	.. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	411
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	412	`Commits Archive (llvm-commits)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	413	This list contains all commit messages that are made when LLVM developers
Sean Silva	2a74699	2013-03-30 15:33:02 +0000	[diff] [blame]	414	commit code changes to the repository. It also serves as a forum for
				415	patch review (i.e. send patches here). It is useful for those who want to
				416	stay on the bleeding edge of LLVM development. This list is very high
				417	volume.
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	418
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	419	.. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	420
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	421	`Bugs & Patches Archive (llvmbugs)`__
Sean Silva	2a74699	2013-03-30 15:33:02 +0000	[diff] [blame]	422	This list gets emailed every time a bug is opened and closed. It is
				423	higher volume than the LLVMdev list.
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	424
				425	.. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
				426
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	427	`Test Results Archive (llvm-testresults)`__
Sean Silva	12159ff	2013-01-20 02:19:36 +0000	[diff] [blame]	428	A message is automatically sent to this list by every active nightly tester
				429	when it completes. As such, this list gets email several times each day,
				430	making it a high volume list.
				431
Sean Silva	9d0eb94	2013-01-20 02:19:42 +0000	[diff] [blame]	432	.. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
				433
Sean Silva	ab4997d	2013-03-30 15:33:01 +0000	[diff] [blame]	434	`LLVM Announcements List (llvm-announce)`__
Sean Silva	84b296c	2013-03-30 15:32:54 +0000	[diff] [blame]	435	This is a low volume list that provides important announcements regarding
				436	LLVM. It gets email about once a month.
				437
				438	.. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
				439
Sean Silva	0129924	2013-03-30 15:32:51 +0000	[diff] [blame]	440	IRC
				441	---
				442
				443	Users and developers of the LLVM project (including subprojects such as Clang)
				444	can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
				445
				446	This channel has several bots.
				447
				448	* Buildbot reporters
				449
				450	* llvmbb - Bot for the main LLVM buildbot master.
				451	http://lab.llvm.org:8011/console
				452	* bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
				453	* smooshlab - Apple's internal buildbot master.
				454
				455	* robot - Bugzilla linker. %bug <number>
				456
				457	* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
				458	near-trunk clang instead of gcc.
				459
				460
Daniel Dunbar	fbb8041	2012-04-19 16:31:37 +0000	[diff] [blame]	461	Indices and tables
				462	==================
				463
				464	* :ref:`genindex`
				465	* :ref:`search`