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

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