docs/userguides.rst

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