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    yaml2obj\r
  22    MarkdownQuickstartTemplate\r
  23    Phabricator\r
  24    Passes\r
  25    YamlIO\r
  26    GetElementPtr\r
  27    Frontend/PerformanceTips\r
  28    MCJITDesignAndImplementation\r
  29    ORCv2\r
  30    CodeOfConduct\r
  31    CompileCudaWithLLVM\r
  32    ReportingGuide\r
  33    Benchmarking\r
  34    Docker\r
  35    BuildingADistribution\r
  36    Remarks\r
  37 \r
  38 Building, Packaging, and Distributing LLVM\r
  39 ------------------------------------------\r
  40 \r
  41 How to build, package, and distribute LLVM.\r
  42 \r
  43 =====\r
  44 CMake\r
  45 =====\r
  46 \r
  47 :doc:`BuildingADistribution`\r
  48   A best-practices guide for using LLVM's CMake build system to package and\r
  49   distribute LLVM-based tools.\r
  50 \r
  51 :doc:`CMake`\r
  52    An addendum to the main Getting Started guide for those using the `CMake\r
  53    build system <http://www.cmake.org>`_.\r
  54 \r
  55 =====\r
  56 Clang\r
  57 =====\r
  58 \r
  59 :doc:`HowToBuildOnARM`\r
  60    Notes on building and testing LLVM/Clang on ARM.\r
  61 \r
  62 :doc:`HowToBuildWithPGO`\r
  63     Notes on building LLVM/Clang with PGO.\r
  64 \r
  65 :doc:`HowToCrossCompileLLVM`\r
  66    Notes on cross-building and testing LLVM/Clang.\r
  67 \r
  68 `How to build the C, C++, ObjC, and ObjC++ front end`__\r
  69    Instructions for building the clang front-end from source.\r
  70 \r
  71    .. __: http://clang.llvm.org/get_started.html\r
  72 \r
  73 ======\r
  74 Docker\r
  75 ======\r
  76 \r
  77 :doc:`Docker`\r
  78    A reference for using Dockerfiles provided with LLVM.\r
  79 \r
  80 =================\r
  81 Additional Topics\r
  82 =================\r
  83 \r
  84 :doc:`HowToCrossCompileBuiltinsOnArm`\r
  85    Notes on cross-building and testing the compiler-rt builtins for Arm.\r
  86 \r
  87 :doc:`Passes`\r
  88    A list of optimizations and analyses implemented in LLVM.\r
  89 \r
  90 :doc:`TestSuiteGuide`\r
  91   Describes how to compile and run the test-suite benchmarks.\r
  92 \r
  93 :doc:`YamlIO`\r
  94    A reference guide for using LLVM's YAML I/O library.\r
  95 \r
  96 :doc:`GetElementPtr`\r
  97   Answers to some very frequent questions about LLVM's most frequently\r
  98   misunderstood instruction.\r
  99 \r
 100 :doc:`Frontend/PerformanceTips`\r
 101    A collection of tips for frontend authors on how to generate IR\r
 102    which LLVM is able to effectively optimize.\r
 103 \r
 104 :doc:`Remarks`\r
 105    A reference on the implementation of remarks in LLVM.