6 If you are using a released version of LLVM, see `the download page
7 <http://llvm.org/releases/>`_ to find your documentation.
9 The LLVM compiler infrastructure supports a wide range of projects, from
10 industrial strength compilers to specialized JIT applications to small
13 Similarly, documentation is broken down into several high-level groupings
14 targeted at different audiences:
16 LLVM Design & Overview
17 ======================
19 Several introductory papers and presentations.
27 Defines the LLVM intermediate representation.
29 `Introduction to the LLVM Compiler`__
30 Presentation providing a users introduction to LLVM.
32 .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
35 Book chapter providing a compiler hacker's introduction to LLVM.
37 .. __: http://www.aosabook.org/en/llvm.html
40 `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
43 .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
45 `LLVM: An Infrastructure for Multi-Stage Optimization`__
46 More details (quite old now).
48 .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
50 `Publications mentioning LLVM <http://llvm.org/pubs>`_
56 For those new to the LLVM system.
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
77 SphinxQuickstartTemplate
87 Discusses how to get up and running quickly with the LLVM infrastructure.
88 Everything from unpacking and compilation of the distribution to execution
92 An addendum to the main Getting Started guide for those using the `CMake
93 build system <http://www.cmake.org>`_.
95 :doc:`HowToBuildOnARM`
96 Notes on building and testing LLVM/Clang on ARM.
98 :doc:`GettingStartedVS`
99 An addendum to the main Getting Started guide for those using Visual Studio
102 :doc:`tutorial/index`
103 Tutorials about using LLVM. Includes a tutorial about making a custom
106 :doc:`LLVM Command Guide <CommandGuide/index>`
107 A reference manual for the LLVM command line utilities ("man" pages for LLVM
111 A list of optimizations and analyses implemented in LLVM.
114 A list of common questions and problems and their solutions.
116 :doc:`Release notes for the current release <ReleaseNotes>`
117 This describes new features, known bugs, and other limitations.
119 :doc:`HowToSubmitABug`
120 Instructions for properly submitting information about any bugs you run into
123 :doc:`SphinxQuickstartTemplate`
124 A template + tutorial for writing new Sphinx documentation. It is meant
125 to be read in source form.
127 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
128 A reference manual for using the LLVM testing infrastructure.
130 `How to build the C, C++, ObjC, and ObjC++ front end`__
131 Instructions for building the clang front-end from source.
133 .. __: http://clang.llvm.org/get_started.html
136 Definition of acronyms, terms and concepts used in LLVM.
138 :doc:`HowToAddABuilder`
139 Instructions for adding new builder to LLVM buildbot master.
142 A reference guide for using LLVM's YAML I/O library.
145 Answers to some very frequent questions about LLVM's most frequently
146 misunderstood instruction.
148 Programming Documentation
149 =========================
151 For developers of applications which use LLVM as a library.
161 HowToSetUpLLVMStyleRTTI
164 :doc:`LLVM Language Reference Manual <LangRef>`
165 Defines the LLVM intermediate representation and the assembly form of the
169 Information about LLVM's concurrency model.
171 :doc:`ProgrammersManual`
172 Introduction to the general layout of the LLVM sourcebase, important classes
173 and APIs, and some tips & tricks.
176 Provides information on using the command line parsing library.
178 :doc:`CodingStandards`
179 Details the LLVM coding standards and provides useful information on writing
182 :doc:`HowToSetUpLLVMStyleRTTI`
183 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
187 Look here to see how to add instructions and intrinsics to LLVM.
189 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
190 (`classes <http://llvm.org/doxygen/inherits.html>`_)
191 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
193 `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
196 :doc:`CompilerWriterInfo`
197 A list of helpful links for compiler writers.
199 Subsystem Documentation
200 =======================
202 For API clients and LLVM developers.
228 :doc:`WritingAnLLVMPass`
229 Information on how to write LLVM transformations and analyses.
231 :doc:`WritingAnLLVMBackend`
232 Information on how to write LLVM backends for machine targets.
235 The design and implementation of the LLVM code generator. Useful if you are
236 working on retargetting LLVM to a new architecture, designing a new codegen
237 pass, or enhancing existing components.
239 :doc:`TableGenFundamentals`
240 Describes the TableGen tool, which is used heavily by the LLVM code
244 Information on how to write a new alias analysis implementation or how to
245 use existing analyses.
247 :doc:`GarbageCollection`
248 The interfaces source-language compilers should use for compiling GC'd
251 :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
252 This document describes the design and philosophy behind the LLVM
253 source-level debugger.
256 This document describes the current status of vectorization in LLVM.
258 :doc:`ExceptionHandling`
259 This document describes the design and implementation of exception handling
263 Automatic bug finder and test-case reducer description and usage
267 This describes the file format and encoding used for LLVM "bc" files.
269 :doc:`System Library <SystemLibrary>`
270 This document describes the LLVM System Library (``lib/System``) and
271 how to keep LLVM source code portable
273 :doc:`LinkTimeOptimization`
274 This document describes the interface between LLVM intermodular optimizer
275 and the linker and its design
278 How to build your programs with link-time optimization on Linux.
280 :doc:`DebuggingJITedCode`
281 How to debug JITed code with GDB.
283 :doc:`BranchWeightMetadata`
284 Provides information about Branch Prediction Information.
286 :doc:`SegmentedStacks`
287 This document describes segmented stacks and how they are used in LLVM.
289 :doc:`MarkedUpDisassembly`
290 This document describes the optional rich disassembly output syntax.
292 :doc:`HowToUseAttributes`
293 Answers some questions about the new Attributes infrastructure.
295 Development Process Documentation
296 =================================
298 Information about LLVM's development process.
310 :doc:`DeveloperPolicy`
311 The LLVM project's policy towards developers and their contributions.
314 How-to guide and templates for new projects that *use* the LLVM
315 infrastructure. The templates (directory organization, Makefiles, and test
316 tree) allow the project code to be located outside (or inside) the ``llvm/``
317 tree, while using LLVM header files and libraries.
320 Describes the LLVMBuild organization and files used by LLVM to specify
321 component descriptions.
324 Describes how the LLVM makefiles work and how to use them.
326 :doc:`HowToReleaseLLVM`
327 This is a guide to preparing LLVM releases. Most developers can ignore it.
330 Advice on packaging LLVM into a distribution.
335 LLVM has a thriving community of friendly and helpful developers.
336 The two primary communication mechanisms in the LLVM community are mailing
342 If you can't find what you need in these docs, try consulting the mailing
345 `LLVM Announcements List`__
346 This is a low volume list that provides important announcements regarding
347 LLVM. It gets email about once a month.
349 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
352 This list is for people who want to be included in technical discussions of
353 LLVM. People post to this list when they have questions about writing code
354 for or using the LLVM tools. It is relatively low volume.
356 .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
358 `Bugs & Patches Archive`__
359 This list gets emailed every time a bug is opened and closed, and when people
360 submit patches to be included in LLVM. It is higher volume than the LLVMdev
363 .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
366 This list contains all commit messages that are made when LLVM developers
367 commit code changes to the repository. It is useful for those who want to
368 stay on the bleeding edge of LLVM development. This list is very high volume.
370 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
372 `Test Results Archive`__
373 A message is automatically sent to this list by every active nightly tester
374 when it completes. As such, this list gets email several times each day,
375 making it a high volume list.
377 .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
382 Users and developers of the LLVM project (including subprojects such as Clang)
383 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
385 This channel has several bots.
389 * llvmbb - Bot for the main LLVM buildbot master.
390 http://lab.llvm.org:8011/console
391 * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
392 * smooshlab - Apple's internal buildbot master.
394 * robot - Bugzilla linker. %bug <number>
396 * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
397 near-trunk clang instead of gcc.