docs/index.rst

   1 Overview
   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
   9 The LLVM compiler infrastructure supports a wide range of projects, from
  10 industrial strength compilers to specialized JIT applications to small
  11 research projects.
  12
  13 Similarly, documentation is broken down into several high-level groupings
  14 targeted at different audiences:
  15
  16 LLVM Design & Overview
  17 ======================
  18
  19 Several introductory papers and presentations.
  20
  21 .. toctree::
  22    :hidden:
  23
  24    LangRef
  25
  26 :doc:`LangRef`
  27   Defines the LLVM intermediate representation.
  28
  29 `Introduction to the LLVM Compiler`__
  30   Presentation providing a users introduction to LLVM.
  31
  32   .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
  33
  34 `Intro to LLVM`__
  35   Book chapter providing a compiler hacker's introduction to LLVM.
  36
  37   .. __: http://www.aosabook.org/en/llvm.html
  38
  39
  40 `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
  41   Design overview.
  42
  43   .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
  44
  45 `LLVM: An Infrastructure for Multi-Stage Optimization`__
  46   More details (quite old now).
  47
  48   .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
  49
  50 `Publications mentioning LLVM <http://llvm.org/pubs>`_
  51    ..
  52
  53 User Guides
  54 ===========
  55
  56 For those new to the LLVM system.
  57
  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
  62 representation.
  63
  64 .. toctree::
  65    :hidden:
  66
  67    CMake
  68    HowToBuildOnARM
  69    HowToCrossCompileLLVM
  70    CommandGuide/index
  71    GettingStarted
  72    GettingStartedVS
  73    FAQ
  74    Lexicon
  75    HowToAddABuilder
  76    yaml2obj
  77    HowToSubmitABug
  78    SphinxQuickstartTemplate
  79    Phabricator
  80    TestingGuide
  81    tutorial/index
  82    ReleaseNotes
  83    Passes
  84    YamlIO
  85    GetElementPtr
  86    MCJITDesignAndImplementation
  87
  88 :doc:`GettingStarted`
  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
  93 :doc:`CMake`
  94    An addendum to the main Getting Started guide for those using the `CMake
  95    build system <http://www.cmake.org>`_.
  96
  97 :doc:`HowToBuildOnARM`
  98    Notes on building and testing LLVM/Clang on ARM.
  99
 100 :doc:`HowToCrossCompileLLVM`
 101    Notes on cross-building and testing LLVM/Clang.
 102
 103 :doc:`GettingStartedVS`
 104    An addendum to the main Getting Started guide for those using Visual Studio
 105    on Windows.
 106
 107 :doc:`tutorial/index`
 108    Tutorials about using LLVM. Includes a tutorial about making a custom
 109    language with LLVM.
 110
 111 :doc:`LLVM Command Guide <CommandGuide/index>`
 112    A reference manual for the LLVM command line utilities ("man" pages for LLVM
 113    tools).
 114
 115 :doc:`Passes`
 116    A list of optimizations and analyses implemented in LLVM.
 117
 118 :doc:`FAQ`
 119    A list of common questions and problems and their solutions.
 120
 121 :doc:`Release notes for the current release <ReleaseNotes>`
 122    This describes new features, known bugs, and other limitations.
 123
 124 :doc:`HowToSubmitABug`
 125    Instructions for properly submitting information about any bugs you run into
 126    in the LLVM system.
 127
 128 :doc:`SphinxQuickstartTemplate`
 129   A template + tutorial for writing new Sphinx documentation. It is meant
 130   to be read in source form.
 131
 132 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
 133    A reference manual for using the LLVM testing infrastructure.
 134
 135 `How to build the C, C++, ObjC, and ObjC++ front end`__
 136    Instructions for building the clang front-end from source.
 137
 138    .. __: http://clang.llvm.org/get_started.html
 139
 140 :doc:`Lexicon`
 141    Definition of acronyms, terms and concepts used in LLVM.
 142
 143 :doc:`HowToAddABuilder`
 144    Instructions for adding new builder to LLVM buildbot master.
 145
 146 :doc:`YamlIO`
 147    A reference guide for using LLVM's YAML I/O library.
 148
 149 :doc:`GetElementPtr`
 150   Answers to some very frequent questions about LLVM's most frequently
 151   misunderstood instruction.
 152
 153 Programming Documentation
 154 =========================
 155
 156 For 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
 168    Extensions
 169
 170 :doc:`LLVM Language Reference Manual <LangRef>`
 171   Defines the LLVM intermediate representation and the assembly form of the
 172   different nodes.
 173
 174 :doc:`Atomics`
 175   Information about LLVM's concurrency model.
 176
 177 :doc:`ProgrammersManual`
 178   Introduction to the general layout of the LLVM sourcebase, important classes
 179   and APIs, and some tips & tricks.
 180
 181 :doc:`Extensions`
 182   LLVM-specific extensions to tools and formats LLVM seeks compatibility with.
 183
 184 :doc:`CommandLine`
 185   Provides information on using the command line parsing library.
 186
 187 :doc:`CodingStandards`
 188   Details the LLVM coding standards and provides useful information on writing
 189   efficient C++ code.
 190
 191 :doc:`HowToSetUpLLVMStyleRTTI`
 192   How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
 193   class hierarchy.
 194
 195 :doc:`ExtendingLLVM`
 196   Look here to see how to add instructions and intrinsics to LLVM.
 197
 198 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
 199   (`classes <http://llvm.org/doxygen/inherits.html>`_)
 200   (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
 201
 202 `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
 203    ..
 204
 205 :doc:`CompilerWriterInfo`
 206   A list of helpful links for compiler writers.
 207
 208 Subsystem Documentation
 209 =======================
 210
 211 For 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
 235    HowToUseAttributes
 236    NVPTXUsage
 237    StackMaps
 238
 239 :doc:`WritingAnLLVMPass`
 240    Information on how to write LLVM transformations and analyses.
 241
 242 :doc:`WritingAnLLVMBackend`
 243    Information on how to write LLVM backends for machine targets.
 244
 245 :doc:`CodeGenerator`
 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
 250 :doc:`TableGenFundamentals`
 251    Describes the TableGen tool, which is used heavily by the LLVM code
 252    generator.
 253
 254 :doc:`AliasAnalysis`
 255    Information on how to write a new alias analysis implementation or how to
 256    use existing analyses.
 257
 258 :doc:`GarbageCollection`
 259    The interfaces source-language compilers should use for compiling GC'd
 260    programs.
 261
 262 :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
 263    This document describes the design and philosophy behind the LLVM
 264    source-level debugger.
 265
 266 :doc:`Vectorizers`
 267    This document describes the current status of vectorization in LLVM.
 268
 269 :doc:`ExceptionHandling`
 270    This document describes the design and implementation of exception handling
 271    in LLVM.
 272
 273 :doc:`Bugpoint`
 274    Automatic bug finder and test-case reducer description and usage
 275    information.
 276
 277 :doc:`BitCodeFormat`
 278    This describes the file format and encoding used for LLVM "bc" files.
 279
 280 :doc:`System Library <SystemLibrary>`
 281    This document describes the LLVM System Library (``lib/System``) and
 282    how to keep LLVM source code portable
 283
 284 :doc:`LinkTimeOptimization`
 285    This document describes the interface between LLVM intermodular optimizer
 286    and the linker and its design
 287
 288 :doc:`GoldPlugin`
 289    How to build your programs with link-time optimization on Linux.
 290
 291 :doc:`DebuggingJITedCode`
 292    How to debug JITed code with GDB.
 293
 294 :doc:`MCJITDesignAndImplementation`
 295    Describes the inner workings of MCJIT execution engine.
 296
 297 :doc:`BranchWeightMetadata`
 298    Provides information about Branch Prediction Information.
 299
 300 :doc:`SegmentedStacks`
 301    This document describes segmented stacks and how they are used in LLVM.
 302
 303 :doc:`MarkedUpDisassembly`
 304    This document describes the optional rich disassembly output syntax.
 305
 306 :doc:`HowToUseAttributes`
 307   Answers some questions about the new Attributes infrastructure.
 308
 309 :doc:`NVPTXUsage`
 310    This document describes using the NVPTX back-end to compile GPU kernels.
 311
 312 :doc:`StackMaps`
 313   LLVM support for mapping instruction addresses to the location of
 314   values and allowing code to be patched.
 315
 316 Development Process Documentation
 317 =================================
 318
 319 Information about LLVM's development process.
 320
 321 .. toctree::
 322    :hidden:
 323
 324    DeveloperPolicy
 325    MakefileGuide
 326    Projects
 327    LLVMBuild
 328    HowToReleaseLLVM
 329    Packaging
 330    ReleaseProcess
 331
 332 :doc:`DeveloperPolicy`
 333    The LLVM project's policy towards developers and their contributions.
 334
 335 :doc:`Projects`
 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
 341 :doc:`LLVMBuild`
 342   Describes the LLVMBuild organization and files used by LLVM to specify
 343   component descriptions.
 344
 345 :doc:`MakefileGuide`
 346   Describes how the LLVM makefiles work and how to use them.
 347
 348 :doc:`HowToReleaseLLVM`
 349   This is a guide to preparing LLVM releases. Most developers can ignore it.
 350
 351 :doc:`ReleaseProcess`
 352   This is a validate a new release, during the release process. Most developers can ignore it.
 353
 354 :doc:`Packaging`
 355    Advice on packaging LLVM into a distribution.
 356
 357 Community
 358 =========
 359
 360 LLVM has a thriving community of friendly and helpful developers.
 361 The two primary communication mechanisms in the LLVM community are mailing
 362 lists and IRC.
 363
 364 Mailing Lists
 365 -------------
 366
 367 If you can't find what you need in these docs, try consulting the mailing
 368 lists.
 369
 370 `Developer's List (llvmdev)`__
 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
 375   .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
 376
 377 `Commits Archive (llvm-commits)`__
 378   This list contains all commit messages that are made when LLVM developers
 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.
 383
 384   .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
 385
 386 `Bugs & Patches Archive (llvmbugs)`__
 387   This list gets emailed every time a bug is opened and closed. It is
 388   higher volume than the LLVMdev list.
 389
 390   .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
 391
 392 `Test Results Archive (llvm-testresults)`__
 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
 397   .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
 398
 399 `LLVM Announcements List (llvm-announce)`__
 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
 405 IRC
 406 ---
 407
 408 Users and developers of the LLVM project (including subprojects such as Clang)
 409 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
 410
 411 This 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
 426 Indices and tables
 427 ==================
 428
 429 * :ref:`genindex`
 430 * :ref:`search`