llvm/docs/ReleaseNotes.rst

   1 ============================
   2 LLVM |release| Release Notes
   3 ============================
   4
   5 .. contents::
   6     :local:
   7
   8 .. only:: PreRelease
   9
  10   .. warning::
  11      These are in-progress notes for the upcoming LLVM |version| release.
  12      Release notes for previous releases can be found on
  13      `the Download Page <https://releases.llvm.org/download.html>`_.
  14
  15
  16 Introduction
  17 ============
  18
  19 This document contains the release notes for the LLVM Compiler Infrastructure,
  20 release |release|.  Here we describe the status of LLVM, including major improvements
  21 from the previous release, improvements in various subprojects of LLVM, and
  22 some of the current users of the code.  All LLVM releases may be downloaded
  23 from the `LLVM releases web site <https://llvm.org/releases/>`_.
  24
  25 For more information about LLVM, including information about the latest
  26 release, please check out the `main LLVM web site <https://llvm.org/>`_.  If you
  27 have questions or comments, the `Discourse forums
  28 <https://discourse.llvm.org>`_ is a good place to ask
  29 them.
  30
  31 Note that if you are reading this file from a Git checkout or the main
  32 LLVM web page, this document applies to the *next* release, not the current
  33 one.  To see the release notes for a specific release, please see the `releases
  34 page <https://llvm.org/releases/>`_.
  35
  36 Non-comprehensive list of changes in this release
  37 =================================================
  38 .. NOTE
  39    For small 1-3 sentence descriptions, just add an entry at the end of
  40    this list. If your description won't fit comfortably in one bullet
  41    point (e.g. maybe you would like to give an example of the
  42    functionality, or simply have a lot to talk about), see the `NOTE` below
  43    for adding a new subsection.
  44
  45 * ...
  46
  47 Update on required toolchains to build LLVM
  48 -------------------------------------------
  49
  50 LLVM is now built with C++17 by default. This means C++17 can be used in
  51 the code base.
  52
  53 The previous "soft" toolchain requirements have now been changed to "hard".
  54 This means that the the following versions are now required to build LLVM
  55 and there is no way to suppress this error.
  56
  57 * GCC >= 7.1
  58 * Clang >= 5.0
  59 * Apple Clang >= 9.3
  60 * Visual Studio 2019 >= 16.7
  61
  62 Changes to the LLVM IR
  63 ----------------------
  64
  65 Changes to building LLVM
  66 ------------------------
  67
  68 Changes to TableGen
  69 -------------------
  70
  71 Changes to the AArch64 Backend
  72 ------------------------------
  73
  74 Changes to the AMDGPU Backend
  75 -----------------------------
  76
  77 Changes to the ARM Backend
  78 --------------------------
  79
  80 Changes to the AVR Backend
  81 --------------------------
  82
  83 * ...
  84
  85 Changes to the DirectX Backend
  86 ------------------------------
  87
  88 Changes to the Hexagon Backend
  89 ------------------------------
  90
  91 * ...
  92
  93 Changes to the MIPS Backend
  94 ---------------------------
  95
  96 * ...
  97
  98 Changes to the PowerPC Backend
  99 ------------------------------
 100
 101 * ...
 102
 103 Changes to the RISC-V Backend
 104 -----------------------------
 105
 106 Changes to the WebAssembly Backend
 107 ----------------------------------
 108
 109 * ...
 110
 111 Changes to the Windows Target
 112 -----------------------------
 113
 114 * For MinGW, generate embedded ``-exclude-symbols:`` directives for symbols
 115   with hidden visibility, omitting them from automatic export of all symbols.
 116   This roughly makes hidden visibility work like it does for other object
 117   file formats.
 118
 119 Changes to the X86 Backend
 120 --------------------------
 121
 122 Changes to the OCaml bindings
 123 -----------------------------
 124
 125
 126 Changes to the C API
 127 --------------------
 128
 129 Changes to the Go bindings
 130 --------------------------
 131
 132
 133 Changes to the FastISel infrastructure
 134 --------------------------------------
 135
 136 * ...
 137
 138 Changes to the DAG infrastructure
 139 ---------------------------------
 140
 141
 142 Changes to the Metadata Info
 143 ---------------------------------
 144
 145 * Add Module Flags Metadata ``stack-protector-guard-symbol`` which specify a
 146   symbol for addressing the stack-protector guard.
 147
 148 Changes to the Debug Info
 149 ---------------------------------
 150
 151 During this release ...
 152
 153 Changes to the LLVM tools
 154 ---------------------------------
 155
 156 Changes to LLDB
 157 ---------------------------------
 158
 159 Changes to Sanitizers
 160 ---------------------
 161
 162
 163 Other Changes
 164 -------------
 165
 166 External Open Source Projects Using LLVM 15
 167 ===========================================
 168
 169 * A project...
 170
 171 Additional Information
 172 ======================
 173
 174 A wide variety of additional information is available on the `LLVM web page
 175 <https://llvm.org/>`_, in particular in the `documentation
 176 <https://llvm.org/docs/>`_ section.  The web page also contains versions of the
 177 API documentation which is up-to-date with the Git version of the source
 178 code.  You can access versions of these documents specific to this release by
 179 going into the ``llvm/docs/`` directory in the LLVM tree.
 180
 181 If you have any questions or comments about LLVM, please feel free to contact
 182 us via the `Discourse forums <https://discourse.llvm.org>`_.