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.
29 Defines the LLVM intermediate representation.
31 * `Introduction to the LLVM Compiler <http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html>`_
33 Presentation providing a users introduction to LLVM.
35 * `Intro to LLVM <http://www.aosabook.org/en/llvm.html>`_
37 Book chapter providing a compiler hacker's introduction to LLVM.
39 * `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation
40 <http://llvm.org/pubs/2004-01-30-CGO-LLVM.html>`_
44 * `LLVM: An Infrastructure for Multi-Stage Optimization
45 <http://llvm.org/pubs/2002-12-LattnerMSThesis.html>`_
47 More details (quite old now).
49 * :doc:`GetElementPtr`
51 Answers to some very frequent questions about LLVM's most frequently
52 misunderstood instruction.
57 The list of `publications <http://llvm.org/pubs>`_ based on LLVM.
62 For those new to the LLVM system.
64 NOTE: If you are a user who is only interested in using LLVM-based
65 compilers, you should look into `Clang <http://clang.llvm.org>`_ or
66 `DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
67 intended for users who have a need to work with the intermediate LLVM
85 SphinxQuickstartTemplate
93 * :doc:`GettingStarted`
95 Discusses how to get up and running quickly with the LLVM infrastructure.
96 Everything from unpacking and compilation of the distribution to execution
101 An addendum to the main Getting Started guide for those using the `CMake
102 build system <http://www.cmake.org>`_.
104 * :doc:`HowToBuildOnARM`
106 Notes on building and testing LLVM/Clang on ARM.
108 * :doc:`GettingStartedVS`
110 An addendum to the main Getting Started guide for those using Visual Studio
113 * :doc:`tutorial/index`
115 Tutorials about using LLVM. Includes a tutorial about making a custom
118 * :doc:`DeveloperPolicy`
120 The LLVM project's policy towards developers and their contributions.
122 * :doc:`LLVM Command Guide <CommandGuide/index>`
124 A reference manual for the LLVM command line utilities ("man" pages for LLVM
129 A list of optimizations and analyses implemented in LLVM.
133 A list of common questions and problems and their solutions.
135 * :doc:`Release notes for the current release <ReleaseNotes>`
137 This describes new features, known bugs, and other limitations.
139 * :doc:`HowToSubmitABug`
141 Instructions for properly submitting information about any bugs you run into
143 * :doc:`SphinxQuickstartTemplate`
145 A template + tutorial for writing new Sphinx documentation. It is meant
146 to be read in source form.
148 * :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
150 A reference manual for using the LLVM testing infrastructure.
152 * `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_
154 Instructions for building the clang front-end from source.
158 Advice on packaging LLVM into a distribution.
162 Definition of acronyms, terms and concepts used in LLVM.
164 * :doc:`HowToAddABuilder`
166 Instructions for adding new builder to LLVM buildbot master.
170 A reference guide for using LLVM's YAML I/O library.
175 You can probably find help on the unofficial LLVM IRC.
177 We often are on irc.oftc.net in the #llvm channel. If you are using the
178 mozilla browser, and have chatzilla installed, you can `join #llvm on
179 irc.oftc.net <irc://irc.oftc.net/llvm>`_.
181 Programming Documentation
182 =========================
184 For developers of applications which use LLVM as a library.
194 HowToSetUpLLVMStyleRTTI
197 * :doc:`LLVM Language Reference Manual <LangRef>`
199 Defines the LLVM intermediate representation and the assembly form of the
204 Information about LLVM's concurrency model.
206 * :doc:`ProgrammersManual`
208 Introduction to the general layout of the LLVM sourcebase, important classes
209 and APIs, and some tips & tricks.
213 Provides information on using the command line parsing library.
215 * :doc:`CodingStandards`
217 Details the LLVM coding standards and provides useful information on writing
220 * :doc:`HowToSetUpLLVMStyleRTTI`
222 How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
225 * :doc:`ExtendingLLVM`
227 Look here to see how to add instructions and intrinsics to LLVM.
229 * `Doxygen generated documentation <http://llvm.org/doxygen/>`_
231 (`classes <http://llvm.org/doxygen/inherits.html>`_)
232 (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
234 * `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
236 * :doc:`CompilerWriterInfo`
238 A list of helpful links for compiler writers.
240 Subsystem Documentation
241 =======================
243 For API clients and LLVM developers.
268 * :doc:`WritingAnLLVMPass`
270 Information on how to write LLVM transformations and analyses.
272 * :doc:`WritingAnLLVMBackend`
274 Information on how to write LLVM backends for machine targets.
276 * :doc:`CodeGenerator`
278 The design and implementation of the LLVM code generator. Useful if you are
279 working on retargetting LLVM to a new architecture, designing a new codegen
280 pass, or enhancing existing components.
282 * :doc:`TableGenFundamentals`
284 Describes the TableGen tool, which is used heavily by the LLVM code
287 * :doc:`AliasAnalysis`
289 Information on how to write a new alias analysis implementation or how to
290 use existing analyses.
292 * :doc:`GarbageCollection`
294 The interfaces source-language compilers should use for compiling GC'd
297 * :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
299 This document describes the design and philosophy behind the LLVM
300 source-level debugger.
304 This document describes the current status of vectorization in LLVM.
306 * :doc:`ExceptionHandling`
308 This document describes the design and implementation of exception handling
313 Automatic bug finder and test-case reducer description and usage
316 * :doc:`BitCodeFormat`
318 This describes the file format and encoding used for LLVM "bc" files.
320 * :doc:`System Library <SystemLibrary>`
322 This document describes the LLVM System Library (``lib/System``) and
323 how to keep LLVM source code portable
325 * :doc:`LinkTimeOptimization`
327 This document describes the interface between LLVM intermodular optimizer
328 and the linker and its design
332 How to build your programs with link-time optimization on Linux.
334 * :doc:`DebuggingJITedCode`
336 How to debug JITed code with GDB.
338 * :doc:`BranchWeightMetadata`
340 Provides information about Branch Prediction Information.
342 * :doc:`SegmentedStacks`
344 This document describes segmented stacks and how they are used in LLVM.
346 * :doc:`MarkedUpDisassembly`
348 This document describes the optional rich disassembly output syntax.
351 Development Process Documentation
352 =================================
355 Information about LLVM's development process.
367 How-to guide and templates for new projects that *use* the LLVM
368 infrastructure. The templates (directory organization, Makefiles, and test
369 tree) allow the project code to be located outside (or inside) the ``llvm/``
370 tree, while using LLVM header files and libraries.
374 Describes the LLVMBuild organization and files used by LLVM to specify
375 component descriptions.
377 * :doc:`MakefileGuide`
379 Describes how the LLVM makefiles work and how to use them.
381 * :doc:`HowToReleaseLLVM`
383 This is a guide to preparing LLVM releases. Most developers can ignore it.
388 If you can't find what you need in these docs, try consulting the mailing
391 * `LLVM Announcements List
392 <http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce>`_
394 This is a low volume list that provides important announcements regarding
395 LLVM. It gets email about once a month.
397 * `Developer's List <http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev>`_
399 This list is for people who want to be included in technical discussions of
400 LLVM. People post to this list when they have questions about writing code
401 for or using the LLVM tools. It is relatively low volume.
403 * `Bugs & Patches Archive <http://lists.cs.uiuc.edu/pipermail/llvmbugs/>`_
405 This list gets emailed every time a bug is opened and closed, and when people
406 submit patches to be included in LLVM. It is higher volume than the LLVMdev
409 * `Commits Archive <http://lists.cs.uiuc.edu/pipermail/llvm-commits/>`_
411 This list contains all commit messages that are made when LLVM developers
412 commit code changes to the repository. It is useful for those who want to
413 stay on the bleeding edge of LLVM development. This list is very high volume.
415 * `Test Results Archive
416 <http://lists.cs.uiuc.edu/pipermail/llvm-testresults/>`_
418 A message is automatically sent to this list by every active nightly tester
419 when it completes. As such, this list gets email several times each day,
420 making it a high volume list.