docs/userguides.rst

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