docs/userguides.rst

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