docs/userguides.rst

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