docs/ReleaseNotes.rst

   1 ========================
   2 LLVM 5.0.0 Release Notes
   3 ========================
   4
   5 .. contents::
   6     :local:
   7
   8 .. warning::
   9    These are in-progress notes for the upcoming LLVM 5 release.  You may
  10    prefer the `LLVM 4 Release Notes <http://llvm.org/releases/4.0.0/docs
  11    /ReleaseNotes.html>`_.
  12
  13
  14 Introduction
  15 ============
  16
  17 This document contains the release notes for the LLVM Compiler Infrastructure,
  18 release 5.0.0.  Here we describe the status of LLVM, including major improvements
  19 from the previous release, improvements in various subprojects of LLVM, and
  20 some of the current users of the code.  All LLVM releases may be downloaded
  21 from the `LLVM releases web site <http://llvm.org/releases/>`_.
  22
  23 For more information about LLVM, including information about the latest
  24 release, please check out the `main LLVM web site <http://llvm.org/>`_.  If you
  25 have questions or comments, the `LLVM Developer's Mailing List
  26 <http://lists.llvm.org/mailman/listinfo/llvm-dev>`_ is a good place to send
  27 them.
  28
  29 Note that if you are reading this file from a Subversion checkout or the main
  30 LLVM web page, this document applies to the *next* release, not the current
  31 one.  To see the release notes for a specific release, please see the `releases
  32 page <http://llvm.org/releases/>`_.
  33
  34 Non-comprehensive list of changes in this release
  35 =================================================
  36 .. NOTE
  37    For small 1-3 sentence descriptions, just add an entry at the end of
  38    this list. If your description won't fit comfortably in one bullet
  39    point (e.g. maybe you would like to give an example of the
  40    functionality, or simply have a lot to talk about), see the `NOTE` below
  41    for adding a new subsection.
  42
  43 * ... next change ...
  44
  45 .. NOTE
  46    If you would like to document a larger change, then you can add a
  47    subsection about it right here. You can copy the following boilerplate
  48    and un-indent it (the indentation causes it to be inside this comment).
  49
  50    Special New Feature
  51    -------------------
  52
  53    Makes programs 10x faster by doing Special New Thing.
  54
  55 Changes to the LLVM IR
  56 ----------------------
  57
  58 Changes to the ARM Backend
  59 --------------------------
  60
  61  During this release ...
  62
  63
  64 Changes to the MIPS Target
  65 --------------------------
  66
  67  During this release ...
  68
  69
  70 Changes to the PowerPC Target
  71 -----------------------------
  72
  73  During this release ...
  74
  75 Changes to the X86 Target
  76 -------------------------
  77
  78  During this release ...
  79
  80 Changes to the AMDGPU Target
  81 -----------------------------
  82
  83  During this release ...
  84
  85 Changes to the AVR Target
  86 -----------------------------
  87
  88  During this release ...
  89
  90 Changes to the OCaml bindings
  91 -----------------------------
  92
  93  During this release ...
  94
  95
  96 External Open Source Projects Using LLVM 5
  97 ==========================================
  98
  99 * A project...
 100
 101
 102 Additional Information
 103 ======================
 104
 105 A wide variety of additional information is available on the `LLVM web page
 106 <http://llvm.org/>`_, in particular in the `documentation
 107 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
 108 API documentation which is up-to-date with the Subversion version of the source
 109 code.  You can access versions of these documents specific to this release by
 110 going into the ``llvm/docs/`` directory in the LLVM tree.
 111
 112 If you have any questions or comments about LLVM, please feel free to contact
 113 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.