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

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