docs/userguides.rst

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