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    GetElementPtr
  26
  27 :doc:`LangRef`
  28   Defines the LLVM intermediate representation.
  29
  30 `Introduction to the LLVM Compiler`__
  31   Presentation providing a users introduction to LLVM.
  32
  33   .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
  34
  35 `Intro to LLVM`__
  36   Book chapter providing a compiler hacker's introduction to LLVM.
  37
  38   .. __: http://www.aosabook.org/en/llvm.html
  39
  40
  41 `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
  42   Design overview.
  43
  44   .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
  45
  46 `LLVM: An Infrastructure for Multi-Stage Optimization`__
  47   More details (quite old now).
  48
  49   .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
  50
  51 :doc:`GetElementPtr`
  52   Answers to some very frequent questions about LLVM's most frequently
  53   misunderstood instruction.
  54
  55 `Publications mentioning LLVM <http://llvm.org/pubs>`_
  56    ..
  57
  58 User Guides
  59 ===========
  60
  61 For those new to the LLVM system.
  62
  63 NOTE: If you are a user who is only interested in using LLVM-based
  64 compilers, you should look into `Clang <http://clang.llvm.org>`_ or
  65 `DragonEgg <http://dragonegg.llvm.org>`_ instead. The documentation here is
  66 intended for users who have a need to work with the intermediate LLVM
  67 representation.
  68
  69 .. toctree::
  70    :hidden:
  71
  72    CMake
  73    HowToBuildOnARM
  74    CommandGuide/index
  75    DeveloperPolicy
  76    GettingStarted
  77    GettingStartedVS
  78    FAQ
  79    Lexicon
  80    HowToAddABuilder
  81    yaml2obj
  82    HowToSubmitABug
  83    SphinxQuickstartTemplate
  84    Phabricator
  85    TestingGuide
  86    tutorial/index
  87    ReleaseNotes
  88    Passes
  89    YamlIO
  90
  91 :doc:`GettingStarted`
  92    Discusses how to get up and running quickly with the LLVM infrastructure.
  93    Everything from unpacking and compilation of the distribution to execution
  94    of some tools.
  95
  96 :doc:`CMake`
  97    An addendum to the main Getting Started guide for those using the `CMake
  98    build system <http://www.cmake.org>`_.
  99
 100 :doc:`HowToBuildOnARM`
 101    Notes on building and testing LLVM/Clang on ARM.
 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:`DeveloperPolicy`
 112    The LLVM project's policy towards developers and their contributions.
 113
 114 :doc:`LLVM Command Guide <CommandGuide/index>`
 115    A reference manual for the LLVM command line utilities ("man" pages for LLVM
 116    tools).
 117
 118 :doc:`Passes`
 119    A list of optimizations and analyses implemented in LLVM.
 120
 121 :doc:`FAQ`
 122    A list of common questions and problems and their solutions.
 123
 124 :doc:`Release notes for the current release <ReleaseNotes>`
 125    This describes new features, known bugs, and other limitations.
 126
 127 :doc:`HowToSubmitABug`
 128    Instructions for properly submitting information about any bugs you run into
 129    in the LLVM system.
 130
 131 :doc:`SphinxQuickstartTemplate`
 132   A template + tutorial for writing new Sphinx documentation. It is meant
 133   to be read in source form.
 134
 135 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
 136    A reference manual for using the LLVM testing infrastructure.
 137
 138 `How to build the C, C++, ObjC, and ObjC++ front end`__
 139    Instructions for building the clang front-end from source.
 140
 141    .. __: http://clang.llvm.org/get_started.html
 142
 143 :doc:`Lexicon`
 144    Definition of acronyms, terms and concepts used in LLVM.
 145
 146 :doc:`HowToAddABuilder`
 147    Instructions for adding new builder to LLVM buildbot master.
 148
 149 :doc:`YamlIO`
 150    A reference guide for using LLVM's YAML I/O library.
 151
 152 IRC
 153 ===
 154
 155 Users and developers of the LLVM project (including subprojects such as Clang)
 156 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
 157
 158 This channel has several bots.
 159
 160 * Buildbot reporters
 161
 162   * llvmbb - Bot for the main LLVM buildbot master.
 163     http://lab.llvm.org:8011/console
 164   * bb-chapuni - An individually run buildbot master. http://bb.pgr.jp/console
 165   * smooshlab - Apple's internal buildbot master.
 166
 167 * robot - Bugzilla linker. %bug <number>
 168
 169 * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
 170   near-trunk clang instead of gcc.
 171
 172 Programming Documentation
 173 =========================
 174
 175 For developers of applications which use LLVM as a library.
 176
 177 .. toctree::
 178    :hidden:
 179
 180    Atomics
 181    CodingStandards
 182    CommandLine
 183    CompilerWriterInfo
 184    ExtendingLLVM
 185    HowToSetUpLLVMStyleRTTI
 186    ProgrammersManual
 187
 188 :doc:`LLVM Language Reference Manual <LangRef>`
 189   Defines the LLVM intermediate representation and the assembly form of the
 190   different nodes.
 191
 192 :doc:`Atomics`
 193   Information about LLVM's concurrency model.
 194
 195 :doc:`ProgrammersManual`
 196   Introduction to the general layout of the LLVM sourcebase, important classes
 197   and APIs, and some tips & tricks.
 198
 199 :doc:`CommandLine`
 200   Provides information on using the command line parsing library.
 201
 202 :doc:`CodingStandards`
 203   Details the LLVM coding standards and provides useful information on writing
 204   efficient C++ code.
 205
 206 :doc:`HowToSetUpLLVMStyleRTTI`
 207   How to make ``isa<>``, ``dyn_cast<>``, etc. available for clients of your
 208   class hierarchy.
 209
 210 :doc:`ExtendingLLVM`
 211   Look here to see how to add instructions and intrinsics to LLVM.
 212
 213 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
 214   (`classes <http://llvm.org/doxygen/inherits.html>`_)
 215   (`tarball <http://llvm.org/doxygen/doxygen.tar.gz>`_)
 216
 217 `ViewVC Repository Browser <http://llvm.org/viewvc/>`_
 218    ..
 219
 220 :doc:`CompilerWriterInfo`
 221   A list of helpful links for compiler writers.
 222
 223 Subsystem Documentation
 224 =======================
 225
 226 For API clients and LLVM developers.
 227
 228 .. toctree::
 229    :hidden:
 230
 231    AliasAnalysis
 232    BitCodeFormat
 233    BranchWeightMetadata
 234    Bugpoint
 235    CodeGenerator
 236    ExceptionHandling
 237    LinkTimeOptimization
 238    SegmentedStacks
 239    TableGenFundamentals
 240    DebuggingJITedCode
 241    GoldPlugin
 242    MarkedUpDisassembly
 243    SystemLibrary
 244    SourceLevelDebugging
 245    Vectorizers
 246    WritingAnLLVMBackend
 247    GarbageCollection
 248    WritingAnLLVMPass
 249    TableGen/LangRef
 250
 251 :doc:`WritingAnLLVMPass`
 252    Information on how to write LLVM transformations and analyses.
 253
 254 :doc:`WritingAnLLVMBackend`
 255    Information on how to write LLVM backends for machine targets.
 256
 257 :doc:`CodeGenerator`
 258    The design and implementation of the LLVM code generator.  Useful if you are
 259    working on retargetting LLVM to a new architecture, designing a new codegen
 260    pass, or enhancing existing components.
 261
 262 :doc:`TableGenFundamentals`
 263    Describes the TableGen tool, which is used heavily by the LLVM code
 264    generator.
 265
 266 :doc:`AliasAnalysis`
 267    Information on how to write a new alias analysis implementation or how to
 268    use existing analyses.
 269
 270 :doc:`GarbageCollection`
 271    The interfaces source-language compilers should use for compiling GC'd
 272    programs.
 273
 274 :doc:`Source Level Debugging with LLVM <SourceLevelDebugging>`
 275    This document describes the design and philosophy behind the LLVM
 276    source-level debugger.
 277
 278 :doc:`Vectorizers`
 279    This document describes the current status of vectorization in LLVM.
 280
 281 :doc:`ExceptionHandling`
 282    This document describes the design and implementation of exception handling
 283    in LLVM.
 284
 285 :doc:`Bugpoint`
 286    Automatic bug finder and test-case reducer description and usage
 287    information.
 288
 289 :doc:`BitCodeFormat`
 290    This describes the file format and encoding used for LLVM "bc" files.
 291
 292 :doc:`System Library <SystemLibrary>`
 293    This document describes the LLVM System Library (``lib/System``) and
 294    how to keep LLVM source code portable
 295
 296 :doc:`LinkTimeOptimization`
 297    This document describes the interface between LLVM intermodular optimizer
 298    and the linker and its design
 299
 300 :doc:`GoldPlugin`
 301    How to build your programs with link-time optimization on Linux.
 302
 303 :doc:`DebuggingJITedCode`
 304    How to debug JITed code with GDB.
 305
 306 :doc:`BranchWeightMetadata`
 307    Provides information about Branch Prediction Information.
 308
 309 :doc:`SegmentedStacks`
 310    This document describes segmented stacks and how they are used in LLVM.
 311
 312 :doc:`MarkedUpDisassembly`
 313    This document describes the optional rich disassembly output syntax.
 314
 315
 316 Development Process Documentation
 317 =================================
 318
 319 Information about LLVM's development process.
 320
 321 .. toctree::
 322    :hidden:
 323
 324    MakefileGuide
 325    Projects
 326    LLVMBuild
 327    HowToReleaseLLVM
 328    Packaging
 329
 330 :doc:`Projects`
 331   How-to guide and templates for new projects that *use* the LLVM
 332   infrastructure.  The templates (directory organization, Makefiles, and test
 333   tree) allow the project code to be located outside (or inside) the ``llvm/``
 334   tree, while using LLVM header files and libraries.
 335
 336 :doc:`LLVMBuild`
 337   Describes the LLVMBuild organization and files used by LLVM to specify
 338   component descriptions.
 339
 340 :doc:`MakefileGuide`
 341   Describes how the LLVM makefiles work and how to use them.
 342
 343 :doc:`HowToReleaseLLVM`
 344   This is a guide to preparing LLVM releases. Most developers can ignore it.
 345
 346 :doc:`Packaging`
 347    Advice on packaging LLVM into a distribution.
 348
 349 Mailing Lists
 350 =============
 351
 352 If you can't find what you need in these docs, try consulting the mailing
 353 lists.
 354
 355 `LLVM Announcements List`__
 356   This is a low volume list that provides important announcements regarding
 357   LLVM.  It gets email about once a month.
 358
 359   .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvm-announce
 360
 361 `Developer's List`__
 362   This list is for people who want to be included in technical discussions of
 363   LLVM. People post to this list when they have questions about writing code
 364   for or using the LLVM tools. It is relatively low volume.
 365
 366   .. __: http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev
 367
 368 `Bugs & Patches Archive`__
 369   This list gets emailed every time a bug is opened and closed, and when people
 370   submit patches to be included in LLVM.  It is higher volume than the LLVMdev
 371   list.
 372
 373   .. __: http://lists.cs.uiuc.edu/pipermail/llvmbugs/
 374
 375 `Commits Archive`__
 376   This list contains all commit messages that are made when LLVM developers
 377   commit code changes to the repository. It is useful for those who want to
 378   stay on the bleeding edge of LLVM development. This list is very high volume.
 379
 380   .. __: http://lists.cs.uiuc.edu/pipermail/llvm-commits/
 381
 382 `Test Results Archive`__
 383   A message is automatically sent to this list by every active nightly tester
 384   when it completes.  As such, this list gets email several times each day,
 385   making it a high volume list.
 386
 387   .. __: http://lists.cs.uiuc.edu/pipermail/llvm-testresults/
 388
 389 Indices and tables
 390 ==================
 391
 392 * :ref:`genindex`
 393 * :ref:`search`