docs/ReleaseNotes.rst

   1 ========================
   2 LLVM 4.0.0 Release Notes
   3 ========================
   4
   5 .. contents::
   6     :local:
   7
   8 .. warning::
   9    These are in-progress notes for the upcoming LLVM 4.0.0 release.  You may
  10    prefer the `LLVM 3.8 Release Notes <http://llvm.org/releases/3.8.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 4.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
  37 .. NOTE
  38    For small 1-3 sentence descriptions, just add an entry at the end of
  39    this list. If your description won't fit comfortably in one bullet
  40    point (e.g. maybe you would like to give an example of the
  41    functionality, or simply have a lot to talk about), see the `NOTE` below
  42    for adding a new subsection.
  43
  44 * The definition and uses of LLVM_ATRIBUTE_UNUSED_RESULT in the LLVM source
  45   were replaced with LLVM_NODISCARD, which matches the C++17 [[nodiscard]]
  46   semantics rather than gcc's __attribute__((warn_unused_result)).
  47
  48 * Minimum compiler version to build has been raised to GCC 4.8 and VS 2015.
  49
  50 * ... next change ...
  51
  52 .. NOTE
  53    If you would like to document a larger change, then you can add a
  54    subsection about it right here. You can copy the following boilerplate
  55    and un-indent it (the indentation causes it to be inside this comment).
  56
  57    Special New Feature
  58    -------------------
  59
  60    Makes programs 10x faster by doing Special New Thing.
  61
  62 Changes to the LLVM IR
  63 ----------------------
  64
  65 Changes to the ARM Backend
  66 --------------------------
  67
  68  During this release ...
  69
  70
  71 Changes to the MIPS Target
  72 --------------------------
  73
  74  During this release ...
  75
  76
  77 Changes to the PowerPC Target
  78 -----------------------------
  79
  80  During this release ...
  81
  82 Changes to the X86 Target
  83 -------------------------
  84
  85  During this release ...
  86
  87 Changes to the AMDGPU Target
  88 -----------------------------
  89
  90  During this release ...
  91
  92 Changes to the OCaml bindings
  93 -----------------------------
  94
  95  During this release ...
  96
  97
  98 External Open Source Projects Using LLVM 4.0.0
  99 ==============================================
 100
 101 * A project...
 102
 103
 104 Additional Information
 105 ======================
 106
 107 A wide variety of additional information is available on the `LLVM web page
 108 <http://llvm.org/>`_, in particular in the `documentation
 109 <http://llvm.org/docs/>`_ section.  The web page also contains versions of the
 110 API documentation which is up-to-date with the Subversion version of the source
 111 code.  You can access versions of these documents specific to this release by
 112 going into the ``llvm/docs/`` directory in the LLVM tree.
 113
 114 If you have any questions or comments about LLVM, please feel free to contact
 115 us via the `mailing lists <http://llvm.org/docs/#maillist>`_.