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