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

blob: 2f253485dd0e457bcf71deecd2be0150b562ad6e [file] [log] [blame]

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