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