Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 5e029cecdf2c8bccd9085b001bb2f7679d98ea8d / . / llvm / docs / index.rst
blob: d040632dc6912a951ccbce83c4eb96e4c9b9d233 [file] [log] [blame]
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000[diff] [blame]1Overview
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
9The LLVM compiler infrastructure supports a wide range of projects, from
10industrial strength compilers to specialized JIT applications to small
11research projects.
12
13Similarly, documentation is broken down into several high-level groupings
Benjamin Kramerbde91762012-06-02 10:20:22 +0000[diff] [blame]14targeted at different audiences:
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000[diff] [blame]15
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]16LLVM Design & Overview
17======================
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000[diff] [blame]18
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]19Several introductory papers and presentations.
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000[diff] [blame]20
21.. toctree::
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]22 :hidden:
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000[diff] [blame]23
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]24 LangRef
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]25
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]26:doc:`LangRef`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]27 Defines the LLVM intermediate representation.
28
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]29`Introduction to the LLVM Compiler`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]30 Presentation providing a users introduction to LLVM.
31
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]32 .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]33
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]34`Intro to LLVM`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]35 Book chapter providing a compiler hacker's introduction to LLVM.
36
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]37 .. __: http://www.aosabook.org/en/llvm.html
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]38
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]39
40`LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]41 Design overview.
42
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]43 .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]44
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]45`LLVM: An Infrastructure for Multi-Stage Optimization`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]46 More details (quite old now).
47
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]48 .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]49
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]50`Publications mentioning LLVM <http://llvm.org/pubs>`_
51 ..
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]52
53User Guides
54===========
55
56For those new to the LLVM system.
57
58NOTE: If you are a user who is only interested in using LLVM-based
59compilers, you should look into `Clang <http://clang.llvm.org>`_ or
60`DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
61intended for users who have a need to work with the intermediate LLVM
62representation.
63
64.. toctree::
65 :hidden:
66
67 CMake
68 HowToBuildOnARM
Renato Golind24899b2013-09-08 20:44:48 +0000[diff] [blame]69 HowToCrossCompileLLVM
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]70 CommandGuide/index
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]71 GettingStarted
72 GettingStartedVS
73 FAQ
74 Lexicon
Sean Silva12159ff2013-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 Silva163b5c42013-03-30 15:32:50 +0000[diff] [blame]85 GetElementPtr
Sean Silva3f93a612013-09-09 19:09:00 +0000[diff] [blame]86 MCJITDesignAndImplementation
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]87
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]88:doc:`GettingStarted`
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]93:doc:`CMake`
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]97:doc:`HowToBuildOnARM`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]98 Notes on building and testing LLVM/Clang on ARM.
99
Renato Golind24899b2013-09-08 20:44:48 +0000[diff] [blame]100:doc:`HowToCrossCompileLLVM`
101 Notes on cross-building and testing LLVM/Clang.
102
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]103:doc:`GettingStartedVS`
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]107:doc:`tutorial/index`
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]111:doc:`LLVM Command Guide <CommandGuide/index>`
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]115:doc:`Passes`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]116 A list of optimizations and analyses implemented in LLVM.
117
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]118:doc:`FAQ`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]119 A list of common questions and problems and their solutions.
120
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]121:doc:`Release notes for the current release <ReleaseNotes>`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]122 This describes new features, known bugs, and other limitations.
123
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]124:doc:`HowToSubmitABug`
Sean Silva12159ff2013-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 Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]127
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]128:doc:`SphinxQuickstartTemplate`
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]132:doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]133 A reference manual for using the LLVM testing infrastructure.
134
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]135`How to build the C, C++, ObjC, and ObjC++ front end`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]136 Instructions for building the clang front-end from source.
137
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]138 .. __: http://clang.llvm.org/get_started.html
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]139
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]140:doc:`Lexicon`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]141 Definition of acronyms, terms and concepts used in LLVM.
142
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]143:doc:`HowToAddABuilder`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]144 Instructions for adding new builder to LLVM buildbot master.
145
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]146:doc:`YamlIO`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]147 A reference guide for using LLVM's YAML I/O library.
148
Sean Silva163b5c42013-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 Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]153Programming Documentation
154=========================
155
156For 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 Rieck1da45292013-04-10 23:28:17 +0000[diff] [blame]168 Extensions
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]169
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]170:doc:`LLVM Language Reference Manual <LangRef>`
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]174:doc:`Atomics`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]175 Information about LLVM's concurrency model.
176
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]177:doc:`ProgrammersManual`
Sean Silva12159ff2013-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 Rieck1da45292013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]184:doc:`CommandLine`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]185 Provides information on using the command line parsing library.
186
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]187:doc:`CodingStandards`
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]191:doc:`HowToSetUpLLVMStyleRTTI`
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]195:doc:`ExtendingLLVM`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]196 Look here to see how to add instructions and intrinsics to LLVM.
197
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]198`Doxygen generated documentation <http://llvm.org/doxygen/>`_
Sean Silva12159ff2013-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 Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]202`ViewVC Repository Browser <http://llvm.org/viewvc/>`_
203 ..
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]204
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]205:doc:`CompilerWriterInfo`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]206 A list of helpful links for compiler writers.
207
208Subsystem Documentation
209=======================
210
211For 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 Abbeyba3e9012013-02-12 11:45:22 +0000[diff] [blame]235 HowToUseAttributes
Justin Holewinski45df8822013-03-30 16:41:14 +0000[diff] [blame]236 NVPTXUsage
Andrew Trick5e029ce2013-12-24 02:57:25 +0000[diff] [blame^]237 StackMaps
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]238
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]239:doc:`WritingAnLLVMPass`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]240 Information on how to write LLVM transformations and analyses.
241
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]242:doc:`WritingAnLLVMBackend`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]243 Information on how to write LLVM backends for machine targets.
244
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]245:doc:`CodeGenerator`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]246 The design and implementation of the LLVM code generator. Useful if you are
247 working on retargetting LLVM to a new architecture, designing a new codegen
248 pass, or enhancing existing components.
249
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]250:doc:`TableGenFundamentals`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]251 Describes the TableGen tool, which is used heavily by the LLVM code
252 generator.
253
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]254:doc:`AliasAnalysis`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]255 Information on how to write a new alias analysis implementation or how to
256 use existing analyses.
257
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]258:doc:`GarbageCollection`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]259 The interfaces source-language compilers should use for compiling GC'd
260 programs.
261
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]262:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]263 This document describes the design and philosophy behind the LLVM
264 source-level debugger.
265
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]266:doc:`Vectorizers`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]267 This document describes the current status of vectorization in LLVM.
268
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]269:doc:`ExceptionHandling`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]270 This document describes the design and implementation of exception handling
271 in LLVM.
272
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]273:doc:`Bugpoint`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]274 Automatic bug finder and test-case reducer description and usage
275 information.
276
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]277:doc:`BitCodeFormat`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]278 This describes the file format and encoding used for LLVM "bc" files.
279
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]280:doc:`System Library <SystemLibrary>`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]281 This document describes the LLVM System Library (``lib/System``) and
282 how to keep LLVM source code portable
283
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]284:doc:`LinkTimeOptimization`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]285 This document describes the interface between LLVM intermodular optimizer
286 and the linker and its design
287
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]288:doc:`GoldPlugin`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]289 How to build your programs with link-time optimization on Linux.
290
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]291:doc:`DebuggingJITedCode`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]292 How to debug JITed code with GDB.
293
Andrew Kaylor27299c32013-08-21 22:15:09 +0000[diff] [blame]294:doc:`MCJITDesignAndImplementation`
295 Describes the inner workings of MCJIT execution engine.
296
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]297:doc:`BranchWeightMetadata`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]298 Provides information about Branch Prediction Information.
299
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]300:doc:`SegmentedStacks`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]301 This document describes segmented stacks and how they are used in LLVM.
302
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]303:doc:`MarkedUpDisassembly`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]304 This document describes the optional rich disassembly output syntax.
305
Joe Abbeyba3e9012013-02-12 11:45:22 +0000[diff] [blame]306:doc:`HowToUseAttributes`
307 Answers some questions about the new Attributes infrastructure.
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]308
Justin Holewinski45df8822013-03-30 16:41:14 +0000[diff] [blame]309:doc:`NVPTXUsage`
310 This document describes using the NVPTX back-end to compile GPU kernels.
311
Andrew Trick5e029ce2013-12-24 02:57:25 +0000[diff] [blame^]312:doc:`StackMaps`
313 LLVM support for mapping instruction addresses to the location of
314 values and allowing code to be patched.
Justin Holewinski45df8822013-03-30 16:41:14 +0000[diff] [blame]315
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]316Development Process Documentation
317=================================
318
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]319Information about LLVM's development process.
320
321.. toctree::
322 :hidden:
323
Sean Silva9d205c82013-03-30 15:32:47 +0000[diff] [blame]324 DeveloperPolicy
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]325 MakefileGuide
326 Projects
327 LLVMBuild
328 HowToReleaseLLVM
Sean Silvabdb940f2013-01-28 21:28:10 +0000[diff] [blame]329 Packaging
Sean Silva3f93a612013-09-09 19:09:00 +0000[diff] [blame]330 ReleaseProcess
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]331
Sean Silva9d205c82013-03-30 15:32:47 +0000[diff] [blame]332:doc:`DeveloperPolicy`
333 The LLVM project's policy towards developers and their contributions.
334
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]335:doc:`Projects`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]336 How-to guide and templates for new projects that *use* the LLVM
337 infrastructure. The templates (directory organization, Makefiles, and test
338 tree) allow the project code to be located outside (or inside) the ``llvm/``
339 tree, while using LLVM header files and libraries.
340
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]341:doc:`LLVMBuild`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]342 Describes the LLVMBuild organization and files used by LLVM to specify
343 component descriptions.
344
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]345:doc:`MakefileGuide`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]346 Describes how the LLVM makefiles work and how to use them.
347
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]348:doc:`HowToReleaseLLVM`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]349 This is a guide to preparing LLVM releases. Most developers can ignore it.
350
Renato Golinc08f2182013-05-28 10:32:55 +0000[diff] [blame]351:doc:`ReleaseProcess`
352 This is a validate a new release, during the release process. Most developers can ignore it.
353
Sean Silvabdb940f2013-01-28 21:28:10 +0000[diff] [blame]354:doc:`Packaging`
355 Advice on packaging LLVM into a distribution.
356
Sean Silva01299242013-03-30 15:32:51 +0000[diff] [blame]357Community
358=========
359
360LLVM has a thriving community of friendly and helpful developers.
361The two primary communication mechanisms in the LLVM community are mailing
362lists and IRC.
363
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]364Mailing Lists
Sean Silva01299242013-03-30 15:32:51 +0000[diff] [blame]365-------------
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]366
367If you can't find what you need in these docs, try consulting the mailing
368lists.
369
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]370`Developer's List (llvmdev)`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]371 This list is for people who want to be included in technical discussions of
372 LLVM. People post to this list when they have questions about writing code
373 for or using the LLVM tools. It is relatively low volume.
374
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]375 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]376
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]377`Commits Archive (llvm-commits)`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]378 This list contains all commit messages that are made when LLVM developers
Sean Silva2a746992013-03-30 15:33:02 +0000[diff] [blame]379 commit code changes to the repository. It also serves as a forum for
380 patch review (i.e. send patches here). It is useful for those who want to
381 stay on the bleeding edge of LLVM development. This list is very high
382 volume.
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]383
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]384 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]385
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]386`Bugs & Patches Archive (llvmbugs)`__
Sean Silva2a746992013-03-30 15:33:02 +0000[diff] [blame]387 This list gets emailed every time a bug is opened and closed. It is
388 higher volume than the LLVMdev list.
Sean Silva84b296c2013-03-30 15:32:54 +0000[diff] [blame]389
390 .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
391
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]392`Test Results Archive (llvm-testresults)`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]393 A message is automatically sent to this list by every active nightly tester
394 when it completes. As such, this list gets email several times each day,
395 making it a high volume list.
396
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]397 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
398
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]399`LLVM Announcements List (llvm-announce)`__
Sean Silva84b296c2013-03-30 15:32:54 +0000[diff] [blame]400 This is a low volume list that provides important announcements regarding
401 LLVM. It gets email about once a month.
402
403 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
404
Sean Silva01299242013-03-30 15:32:51 +0000[diff] [blame]405IRC
406---
407
408Users and developers of the LLVM project (including subprojects such as Clang)
409can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
410
411This channel has several bots.
412
413* Buildbot reporters
414
415 * llvmbb - Bot for the main LLVM buildbot master.
416 http://lab.llvm.org:8011/console
417 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
418 * smooshlab - Apple's internal buildbot master.
419
420* robot - Bugzilla linker. %bug <number>
421
422* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
423 near-trunk clang instead of gcc.
424
425
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000[diff] [blame]426Indices and tables
427==================
428
429* :ref:`genindex`
430* :ref:`search`