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

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