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

blob: 62766f10342fe0b6d512172cb6658d46808b1136 [file] [log] [blame]

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