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