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