docs/userguides.rst

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