Gitiles
Code Review Sign In
gerrit-public.fairphone.software / toolchain / llvm-project / 6e40cec5fd240082daefb3243c411d490f8e4027 / . / llvm / docs / index.rst
blob: 93a160028be13da7aa1f49b8dbc23accbe50ba17 [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
Duncan P. N. Exon Smith6e40cec2014-04-11 23:21:07 +0000[diff] [blame^]218 BlockFrequencyTerminology
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]219 BranchWeightMetadata
220 Bugpoint
221 CodeGenerator
222 ExceptionHandling
223 LinkTimeOptimization
224 SegmentedStacks
225 TableGenFundamentals
Renato Golinca105642014-03-20 16:08:34 +0000[diff] [blame]226 TableGen/index
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]227 DebuggingJITedCode
228 GoldPlugin
229 MarkedUpDisassembly
230 SystemLibrary
231 SourceLevelDebugging
232 Vectorizers
233 WritingAnLLVMBackend
234 GarbageCollection
235 WritingAnLLVMPass
Joe Abbeyba3e9012013-02-12 11:45:22 +0000[diff] [blame]236 HowToUseAttributes
Justin Holewinski45df8822013-03-30 16:41:14 +0000[diff] [blame]237 NVPTXUsage
Andrew Trick5e029ce2013-12-24 02:57:25 +0000[diff] [blame]238 StackMaps
Sean Silva216f1ee2014-03-02 00:21:42 +0000[diff] [blame]239 InAlloca
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]240
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]241:doc:`WritingAnLLVMPass`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]242 Information on how to write LLVM transformations and analyses.
243
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]244:doc:`WritingAnLLVMBackend`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]245 Information on how to write LLVM backends for machine targets.
246
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]247:doc:`CodeGenerator`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]248 The design and implementation of the LLVM code generator. Useful if you are
249 working on retargetting LLVM to a new architecture, designing a new codegen
250 pass, or enhancing existing components.
251
Sean Silva0b4df9b2014-04-07 22:42:53 +0000[diff] [blame]252:doc:`TableGen <TableGen/index>`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]253 Describes the TableGen tool, which is used heavily by the LLVM code
254 generator.
255
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]256:doc:`AliasAnalysis`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]257 Information on how to write a new alias analysis implementation or how to
258 use existing analyses.
259
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]260:doc:`GarbageCollection`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]261 The interfaces source-language compilers should use for compiling GC'd
262 programs.
263
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]264:doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]265 This document describes the design and philosophy behind the LLVM
266 source-level debugger.
267
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]268:doc:`Vectorizers`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]269 This document describes the current status of vectorization in LLVM.
270
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]271:doc:`ExceptionHandling`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]272 This document describes the design and implementation of exception handling
273 in LLVM.
274
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]275:doc:`Bugpoint`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]276 Automatic bug finder and test-case reducer description and usage
277 information.
278
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]279:doc:`BitCodeFormat`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]280 This describes the file format and encoding used for LLVM "bc" files.
281
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]282:doc:`System Library <SystemLibrary>`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]283 This document describes the LLVM System Library (``lib/System``) and
284 how to keep LLVM source code portable
285
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]286:doc:`LinkTimeOptimization`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]287 This document describes the interface between LLVM intermodular optimizer
288 and the linker and its design
289
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]290:doc:`GoldPlugin`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]291 How to build your programs with link-time optimization on Linux.
292
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]293:doc:`DebuggingJITedCode`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]294 How to debug JITed code with GDB.
295
Andrew Kaylor27299c32013-08-21 22:15:09 +0000[diff] [blame]296:doc:`MCJITDesignAndImplementation`
297 Describes the inner workings of MCJIT execution engine.
298
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]299:doc:`BranchWeightMetadata`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]300 Provides information about Branch Prediction Information.
301
Duncan P. N. Exon Smith6e40cec2014-04-11 23:21:07 +0000[diff] [blame^]302:doc:`BlockFrequencyTerminology`
303 Provides information about terminology used in the ``BlockFrequencyInfo``
304 analysis pass.
305
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]306:doc:`SegmentedStacks`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]307 This document describes segmented stacks and how they are used in LLVM.
308
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]309:doc:`MarkedUpDisassembly`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]310 This document describes the optional rich disassembly output syntax.
311
Joe Abbeyba3e9012013-02-12 11:45:22 +0000[diff] [blame]312:doc:`HowToUseAttributes`
313 Answers some questions about the new Attributes infrastructure.
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]314
Justin Holewinski45df8822013-03-30 16:41:14 +0000[diff] [blame]315:doc:`NVPTXUsage`
316 This document describes using the NVPTX back-end to compile GPU kernels.
317
Andrew Trick5e029ce2013-12-24 02:57:25 +0000[diff] [blame]318:doc:`StackMaps`
319 LLVM support for mapping instruction addresses to the location of
320 values and allowing code to be patched.
Justin Holewinski45df8822013-03-30 16:41:14 +0000[diff] [blame]321
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]322Development Process Documentation
323=================================
324
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]325Information about LLVM's development process.
326
327.. toctree::
328 :hidden:
329
Sean Silva9d205c82013-03-30 15:32:47 +0000[diff] [blame]330 DeveloperPolicy
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]331 MakefileGuide
332 Projects
333 LLVMBuild
334 HowToReleaseLLVM
Sean Silvabdb940f2013-01-28 21:28:10 +0000[diff] [blame]335 Packaging
Sean Silva3f93a612013-09-09 19:09:00 +0000[diff] [blame]336 ReleaseProcess
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]337
Sean Silva9d205c82013-03-30 15:32:47 +0000[diff] [blame]338:doc:`DeveloperPolicy`
339 The LLVM project's policy towards developers and their contributions.
340
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]341:doc:`Projects`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]342 How-to guide and templates for new projects that *use* the LLVM
343 infrastructure. The templates (directory organization, Makefiles, and test
344 tree) allow the project code to be located outside (or inside) the ``llvm/``
345 tree, while using LLVM header files and libraries.
346
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]347:doc:`LLVMBuild`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]348 Describes the LLVMBuild organization and files used by LLVM to specify
349 component descriptions.
350
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]351:doc:`MakefileGuide`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]352 Describes how the LLVM makefiles work and how to use them.
353
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]354:doc:`HowToReleaseLLVM`
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]355 This is a guide to preparing LLVM releases. Most developers can ignore it.
356
Renato Golinc08f2182013-05-28 10:32:55 +0000[diff] [blame]357:doc:`ReleaseProcess`
358 This is a validate a new release, during the release process. Most developers can ignore it.
359
Sean Silvabdb940f2013-01-28 21:28:10 +0000[diff] [blame]360:doc:`Packaging`
361 Advice on packaging LLVM into a distribution.
362
Sean Silva01299242013-03-30 15:32:51 +0000[diff] [blame]363Community
364=========
365
366LLVM has a thriving community of friendly and helpful developers.
367The two primary communication mechanisms in the LLVM community are mailing
368lists and IRC.
369
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]370Mailing Lists
Sean Silva01299242013-03-30 15:32:51 +0000[diff] [blame]371-------------
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]372
373If you can't find what you need in these docs, try consulting the mailing
374lists.
375
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]376`Developer's List (llvmdev)`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]377 This list is for people who want to be included in technical discussions of
378 LLVM. People post to this list when they have questions about writing code
379 for or using the LLVM tools. It is relatively low volume.
380
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]381 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]382
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]383`Commits Archive (llvm-commits)`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]384 This list contains all commit messages that are made when LLVM developers
Sean Silva2a746992013-03-30 15:33:02 +0000[diff] [blame]385 commit code changes to the repository. It also serves as a forum for
386 patch review (i.e. send patches here). It is useful for those who want to
387 stay on the bleeding edge of LLVM development. This list is very high
388 volume.
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]389
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]390 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]391
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]392`Bugs & Patches Archive (llvmbugs)`__
Sean Silva2a746992013-03-30 15:33:02 +0000[diff] [blame]393 This list gets emailed every time a bug is opened and closed. It is
394 higher volume than the LLVMdev list.
Sean Silva84b296c2013-03-30 15:32:54 +0000[diff] [blame]395
396 .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
397
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]398`Test Results Archive (llvm-testresults)`__
Sean Silva12159ff2013-01-20 02:19:36 +0000[diff] [blame]399 A message is automatically sent to this list by every active nightly tester
400 when it completes. As such, this list gets email several times each day,
401 making it a high volume list.
402
Sean Silva9d0eb942013-01-20 02:19:42 +0000[diff] [blame]403 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
404
Sean Silvaab4997d2013-03-30 15:33:01 +0000[diff] [blame]405`LLVM Announcements List (llvm-announce)`__
Sean Silva84b296c2013-03-30 15:32:54 +0000[diff] [blame]406 This is a low volume list that provides important announcements regarding
407 LLVM. It gets email about once a month.
408
409 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
410
Sean Silva01299242013-03-30 15:32:51 +0000[diff] [blame]411IRC
412---
413
414Users and developers of the LLVM project (including subprojects such as Clang)
415can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
416
417This channel has several bots.
418
419* Buildbot reporters
420
421 * llvmbb - Bot for the main LLVM buildbot master.
422 http://lab.llvm.org:8011/console
423 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
424 * smooshlab - Apple's internal buildbot master.
425
426* robot - Bugzilla linker. %bug <number>
427
428* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
429 near-trunk clang instead of gcc.
430
431
Daniel Dunbarfbb80412012-04-19 16:31:37 +0000[diff] [blame]432Indices and tables
433==================
434
435* :ref:`genindex`
436* :ref:`search`