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

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