docs/userguides.rst

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