docs/userguides.rst

   1 User Guides
   2 ===========
   3
   4 .. toctree::
   5    :hidden:
   6
   7    CMake
   8    HowToBuildOnARM
   9    CommandGuide/index
  10    DeveloperPolicy
  11    GettingStarted
  12    GettingStartedVS
  13    FAQ
  14    Lexicon
  15    Packaging
  16    HowToAddABuilder
  17    yaml2obj
  18    HowToSubmitABug
  19    SphinxQuickstartTemplate
  20    Phabricator
  21    TestingGuide
  22    tutorial/index
  23    ReleaseNotes
  24    Passes
  25    YamlIO
  26
  27 * :doc:`GettingStarted`
  28
  29    Discusses how to get up and running quickly with the LLVM infrastructure.
  30    Everything from unpacking and compilation of the distribution to execution
  31    of some tools.
  32
  33 * :doc:`CMake`
  34
  35    An addendum to the main Getting Started guide for those using the `CMake
  36    build system <http://www.cmake.org>`_.
  37
  38 * :doc:`HowToBuildOnARM`
  39
  40    Notes on building and testing LLVM/Clang on ARM.
  41
  42 * :doc:`GettingStartedVS`
  43
  44    An addendum to the main Getting Started guide for those using Visual Studio
  45    on Windows.
  46
  47 * :doc:`tutorial/index`
  48
  49    Tutorials about using LLVM. Includes a tutorial about making a custom
  50    language with LLVM.
  51
  52 * :doc:`DeveloperPolicy`
  53
  54    The LLVM project's policy towards developers and their contributions.
  55
  56 * :doc:`LLVM Command Guide <CommandGuide/index>`
  57
  58    A reference manual for the LLVM command line utilities ("man" pages for LLVM
  59    tools).
  60
  61 * :doc:`Passes`
  62
  63    A list of optimizations and analyses implemented in LLVM.
  64
  65 * :doc:`FAQ`
  66
  67    A list of common questions and problems and their solutions.
  68
  69 * :doc:`Release notes for the current release <ReleaseNotes>`
  70
  71    This describes new features, known bugs, and other limitations.
  72
  73 * :doc:`HowToSubmitABug`
  74
  75    Instructions for properly submitting information about any bugs you run into
  76    in the LLVM system.
  77 * :doc:`SphinxQuickstartTemplate`
  78
  79   A template + tutorial for writing new Sphinx documentation. It is meant
  80   to be read in source form.
  81
  82 * :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`
  83
  84    A reference manual for using the LLVM testing infrastructure.
  85
  86 * `How to build the C, C++, ObjC, and ObjC++ front end <http://clang.llvm.org/get_started.html>`_
  87
  88    Instructions for building the clang front-end from source.
  89
  90 * :doc:`Packaging`
  91
  92    Advice on packaging LLVM into a distribution.
  93
  94 * :doc:`Lexicon`
  95
  96    Definition of acronyms, terms and concepts used in LLVM.
  97
  98 * :doc:`HowToAddABuilder`
  99
 100    Instructions for adding new builder to LLVM buildbot master.
 101
 102 * :doc:`YamlIO`
 103
 104    A reference guide for using LLVM's YAML I/O library.
 105
 106 * **IRC** -- You can probably find help on the unofficial LLVM IRC.
 107
 108    We often are on irc.oftc.net in the #llvm channel.  If you are using the
 109    mozilla browser, and have chatzilla installed, you can `join #llvm on
 110    irc.oftc.net <irc://irc.oftc.net/llvm>`_.