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