docs/ReleaseNotes.rst

   1 ========================
   2 LLVM 6.0.0 Release Notes
   3 ========================
   4
   5 .. contents::
   6     :local:
   7
   8 .. warning::
   9    These are in-progress notes for the upcoming LLVM 6 release.
  10    Release notes for previous releases can be found on
  11    `the Download Page <http://releases.llvm.org/download.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 * The ``Redirects`` argument of ``llvm::sys::ExecuteAndWait`` and
  44   ``llvm::sys::ExecuteNoWait`` was changed to an ``ArrayRef`` of optional
  45   ``StringRef``'s to make it safer and more convenient to use.
  46
  47 * The backend name was added to the Target Registry to allow run-time
  48   information to be fed back into TableGen. Out-of-tree targets will need to add
  49   the name used in the `def X : Target` definition to the call to
  50   `RegisterTarget`.
  51
  52 * The ``Debugify`` pass was added to ``opt`` to facilitate testing of debug
  53   info preservation. This pass attaches synthetic ``DILocations`` and
  54   ``DIVariables`` to the instructions in a ``Module``. The ``CheckDebugify``
  55   pass determines how much of the metadata is lost.
  56
  57 * Note..
  58
  59 .. NOTE
  60    If you would like to document a larger change, then you can add a
  61    subsection about it right here. You can copy the following boilerplate
  62    and un-indent it (the indentation causes it to be inside this comment).
  63
  64    Special New Feature
  65    -------------------
  66
  67    Makes programs 10x faster by doing Special New Thing.
  68
  69 Changes to the LLVM IR
  70 ----------------------
  71
  72 Changes to the ARM Backend
  73 --------------------------
  74
  75  During this release ...
  76
  77
  78 Changes to the MIPS Target
  79 --------------------------
  80
  81  During this release ...
  82
  83
  84 Changes to the PowerPC Target
  85 -----------------------------
  86
  87  During this release ...
  88
  89 Changes to the X86 Target
  90 -------------------------
  91
  92  During this release ...
  93
  94 Changes to the AMDGPU Target
  95 -----------------------------
  96
  97  During this release ...
  98
  99 Changes to the AVR Target
 100 -----------------------------
 101
 102  During this release ...
 103
 104 Changes to the OCaml bindings
 105 -----------------------------
 106
 107  During this release ...
 108
 109
 110 Changes to the C API
 111 --------------------
 112
 113  During this release ...
 114
 115
 116 External Open Source Projects Using LLVM 6
 117 ==========================================
 118
 119 * A project...
 120
 121
 122 Additional Information
 123 ======================
 124
 125 A wide variety of additional information is available on the `LLVM web page
 126 <http://llvm.org/>`_, in particular in the `documentation
 127 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
 128 API documentation which is up-to-date with the Subversion version of the source
 129 code.  You can access versions of these documents specific to this release by
 130 going into the ``llvm/docs/`` directory in the LLVM tree.
 131
 132 If you have any questions or comments about LLVM, please feel free to contact
 133 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.