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

blob: a69ecfedc580789da8916982a7894bb74477c7c8 [file] [log] [blame]

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