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
  27 * :ref:`getting_started`
  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 * :ref:`building-with-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 * :ref:`how_to_build_on_arm`
  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    A walk through the process of using LLVM for a custom language, and the
  50    facilities LLVM offers in tutorial form.
  51
  52 * :ref:`developer_policy`
  53
  54    The LLVM project's policy towards developers and their contributions.
  55
  56 * :ref:`LLVM Command Guide <commands>`
  57
  58    A reference manual for the LLVM command line utilities ("man" pages for LLVM
  59    tools).
  60
  61 * `LLVM's Analysis and Transform Passes <Passes.html>`_
  62
  63    A list of optimizations and analyses implemented in LLVM.
  64
  65 * :ref:`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 * :ref:`how-to-submit-a-bug-report`
  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 * :ref:`packaging`
  91
  92    Advice on packaging LLVM into a distribution.
  93
  94 * :ref:`lexicon`
  95
  96    Definition of acronyms, terms and concepts used in LLVM.
  97
  98 * :ref:`how_to_add_a_builder`
  99
 100    Instructions for adding new builder to LLVM buildbot master.
 101
 102 * **IRC** -- You can probably find help on the unofficial LLVM IRC.
 103
 104    We often are on irc.oftc.net in the #llvm channel.  If you are using the
 105    mozilla browser, and have chatzilla installed, you can `join #llvm on
 106    irc.oftc.net <irc://irc.oftc.net/llvm>`_.