docs/userguides.rst

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