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