docs/userguides.rst

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