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