docs/UserGuides.rst

   1 User Guides\r
   2 ===========\r
   3 \r
   4 For those new to the LLVM system.\r
   5 \r
   6 NOTE: If you are a user who is only interested in using an LLVM-based compiler,\r
   7 you should look into `Clang <http://clang.llvm.org>`_ instead. The\r
   8 documentation here is intended for users who have a need to work with the\r
   9 intermediate LLVM representation.\r
  10 \r
  11 .. toctree::\r
  12    :hidden:\r
  13 \r
  14    CMake\r
  15    CMakePrimer\r
  16    AdvancedBuilds\r
  17    HowToBuildOnARM\r
  18    HowToBuildWithPGO\r
  19    HowToCrossCompileBuiltinsOnArm\r
  20    HowToCrossCompileLLVM\r
  21    CommandGuide/index\r
  22    GettingStarted\r
  23    GettingStartedVS\r
  24    FAQ\r
  25    Lexicon\r
  26    HowToAddABuilder\r
  27    yaml2obj\r
  28    MarkdownQuickstartTemplate\r
  29    Phabricator\r
  30    TestingGuide\r
  31    tutorial/index\r
  32    ReleaseNotes\r
  33    Passes\r
  34    YamlIO\r
  35    GetElementPtr\r
  36    Frontend/PerformanceTips\r
  37    MCJITDesignAndImplementation\r
  38    ORCv2\r
  39    CodeOfConduct\r
  40    CompileCudaWithLLVM\r
  41    ReportingGuide\r
  42    Benchmarking\r
  43    Docker\r
  44    BuildingADistribution\r
  45    Remarks\r
  46 \r
  47 :doc:`GettingStarted`\r
  48    Discusses how to get up and running quickly with the LLVM infrastructure.\r
  49    Everything from unpacking and compilation of the distribution to execution\r
  50    of some tools.\r
  51 \r
  52 :doc:`CMake`\r
  53    An addendum to the main Getting Started guide for those using the `CMake\r
  54    build system <http://www.cmake.org>`_.\r
  55 \r
  56 :doc:`HowToBuildOnARM`\r
  57    Notes on building and testing LLVM/Clang on ARM.\r
  58 \r
  59 :doc:`HowToBuildWithPGO`\r
  60     Notes on building LLVM/Clang with PGO.\r
  61 \r
  62 :doc:`HowToCrossCompileBuiltinsOnArm`\r
  63    Notes on cross-building and testing the compiler-rt builtins for Arm.\r
  64 \r
  65 :doc:`HowToCrossCompileLLVM`\r
  66    Notes on cross-building and testing LLVM/Clang.\r
  67 \r
  68 :doc:`GettingStartedVS`\r
  69    An addendum to the main Getting Started guide for those using Visual Studio\r
  70    on Windows.\r
  71 \r
  72 :doc:`tutorial/index`\r
  73    Tutorials about using LLVM. Includes a tutorial about making a custom\r
  74    language with LLVM.\r
  75 \r
  76 :doc:`LLVM Command Guide <CommandGuide/index>`\r
  77    A reference manual for the LLVM command line utilities ("man" pages for LLVM\r
  78    tools).\r
  79 \r
  80 :doc:`Passes`\r
  81    A list of optimizations and analyses implemented in LLVM.\r
  82 \r
  83 :doc:`FAQ`\r
  84    A list of common questions and problems and their solutions.\r
  85 \r
  86 :doc:`Release notes for the current release <ReleaseNotes>`\r
  87    This describes new features, known bugs, and other limitations.\r
  88 \r
  89 :doc:`LLVM Testing Infrastructure Guide <TestingGuide>`\r
  90    A reference manual for using the LLVM testing infrastructure.\r
  91 \r
  92 :doc:`TestSuiteGuide`\r
  93   Describes how to compile and run the test-suite benchmarks.\r
  94 \r
  95 `How to build the C, C++, ObjC, and ObjC++ front end`__\r
  96    Instructions for building the clang front-end from source.\r
  97 \r
  98    .. __: http://clang.llvm.org/get_started.html\r
  99 \r
 100 :doc:`Lexicon`\r
 101    Definition of acronyms, terms and concepts used in LLVM.\r
 102 \r
 103 :doc:`HowToAddABuilder`\r
 104    Instructions for adding new builder to LLVM buildbot master.\r
 105 \r
 106 :doc:`YamlIO`\r
 107    A reference guide for using LLVM's YAML I/O library.\r
 108 \r
 109 :doc:`GetElementPtr`\r
 110   Answers to some very frequent questions about LLVM's most frequently\r
 111   misunderstood instruction.\r
 112 \r
 113 :doc:`Frontend/PerformanceTips`\r
 114    A collection of tips for frontend authors on how to generate IR\r
 115    which LLVM is able to effectively optimize.\r
 116 \r
 117 :doc:`Docker`\r
 118    A reference for using Dockerfiles provided with LLVM.\r
 119 \r
 120 :doc:`BuildingADistribution`\r
 121   A best-practices guide for using LLVM's CMake build system to package and\r
 122   distribute LLVM-based tools.\r
 123 \r
 124 :doc:`Remarks`\r
 125    A reference on the implementation of remarks in LLVM.