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

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