docs/index.rst

   1 About
   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    FAQ
  25    Lexicon
  26
  27 `Introduction to the LLVM Compiler`__
  28   Presentation providing a users introduction to LLVM.
  29
  30   .. __: http://llvm.org/pubs/2008-10-04-ACAT-LLVM-Intro.html
  31
  32 `Intro to LLVM`__
  33   Book chapter providing a compiler hacker's introduction to LLVM.
  34
  35   .. __: http://www.aosabook.org/en/llvm.html
  36
  37
  38 `LLVM: A Compilation Framework for Lifelong Program Analysis & Transformation`__
  39   Design overview.
  40
  41   .. __: http://llvm.org/pubs/2004-01-30-CGO-LLVM.html
  42
  43 `LLVM: An Infrastructure for Multi-Stage Optimization`__
  44   More details (quite old now).
  45
  46   .. __: http://llvm.org/pubs/2002-12-LattnerMSThesis.html
  47
  48 `Publications mentioning LLVM <http://llvm.org/pubs>`_
  49    ..
  50
  51 Documentation
  52 =============
  53
  54 Getting Started, How-tos, Developer Guides, and Tutorials.
  55
  56 .. toctree::
  57    :hidden:
  58
  59    UserGuides
  60    ProgrammingDocumentation
  61    SubsystemDocumentation
  62
  63 :doc:`UserGuides`
  64   For those new to the LLVM system.
  65
  66 :doc:`ProgrammingDocumentation`
  67   For developers of applications which use LLVM as a library.
  68
  69 :doc:`SubsystemDocumentation`
  70   For API clients and LLVM developers.
  71
  72 Getting Started/Tutorials
  73 -------------------------
  74
  75 .. toctree::
  76    :hidden:
  77
  78    GettingStarted
  79    tutorial/index
  80    GettingStartedVS
  81
  82 :doc:`GettingStarted`
  83    Discusses how to get up and running quickly with the LLVM infrastructure.
  84    Everything from unpacking and compilation of the distribution to execution
  85    of some tools.
  86
  87 :doc:`tutorial/index`
  88    Tutorials about using LLVM. Includes a tutorial about making a custom
  89    language with LLVM.
  90
  91 :doc:`GettingStartedVS`
  92    An addendum to the main Getting Started guide for those using Visual Studio
  93    on Windows.
  94
  95 Reference
  96 ---------
  97
  98 LLVM and API reference documentation.
  99
 100 .. toctree::
 101    :hidden:
 102
 103    LangRef
 104    CommandGuide/index
 105    TestingGuide
 106    CompilerWriterInfo
 107    MIRLangRef
 108
 109 :doc:`LLVM Language Reference Manual <LangRef>`
 110   Defines the LLVM intermediate representation and the assembly form of the
 111   different nodes.
 112
 113 :doc:`LLVM Command Guide <CommandGuide/index>`
 114    A reference manual for the LLVM command line utilities ("man" pages for LLVM
 115    tools).
 116
 117 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
 118    A reference manual for using the LLVM testing infrastructure.
 119
 120 :doc:`CompilerWriterInfo`
 121   A list of helpful links for compiler writers.
 122
 123 :doc:`Machine IR (MIR) Format Reference Manual <MIRLangRef>`
 124    A reference manual for the MIR serialization format, which is used to test
 125    LLVM's code generation passes.
 126
 127 `Doxygen generated documentation <http://llvm.org/doxygen/>`_
 128   (`classes <http://llvm.org/doxygen/inherits.html>`_)
 129
 130 `Documentation for Go bindings <http://godoc.org/llvm.org/llvm/bindings/go/llvm>`_
 131
 132 `Github Source Repository Browser <http://github.com/llvm/llvm-project//>`_
 133    ..
 134
 135 Community
 136 =========
 137
 138 LLVM welcomes contributions of all kinds. To learn more, see the following articles:
 139
 140 .. toctree::
 141    :hidden:
 142
 143    GettingInvolved
 144
 145 * :doc:`GettingInvolved`
 146 * :ref:`development-process`
 147 * :ref:`mailing-lists`
 148 * :ref:`meetups-social-events`
 149 * :ref:`community-proposals`
 150
 151 Indices and tables
 152 ==================
 153
 154 * :ref:`genindex`
 155 * :ref:`search`