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