Add the fact that we anticipate switching to use (some subset of) C++11
[oota-llvm.git] / docs / ReleaseNotes.rst
1 ======================
2 LLVM 3.4 Release Notes
3 ======================
4
5 .. contents::
6     :local:
7
8 .. warning::
9    These are in-progress notes for the upcoming LLVM 3.4 release.  You may
10    prefer the `LLVM 3.3 Release Notes <http://llvm.org/releases/3.3/docs
11    /ReleaseNotes.html>`_.
12
13
14 Introduction
15 ============
16
17 This document contains the release notes for the LLVM Compiler Infrastructure,
18 release 3.4.  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.cs.uiuc.edu/mailman/listinfo/llvmdev>`_ 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 * This is expected to be the last release of LLVM which compiles using a C++98
45   toolchain. We expect to start using some C++11 features in LLVM and other
46   sub-projects starting after this release. That said, we are committed to
47   supporting a reasonable set of modern C++ toolchains as the host compiler on
48   all of the platforms. This will at least include Visual Studio 2012 on
49   Windows, and Clang 3.1 or GCC 4.7.x on Mac and Linux. The final set of
50   compilers (and the C++11 features they support) is not set in stone, but we
51   wanted users of LLVM to have a heads up that the next release will involve
52   a substantial change in the host toolchain requirements.
53
54 * The regression tests now fail if any command in a pipe fails. To disable it in
55   a directory, just add ``config.pipefail = False`` to its ``lit.local.cfg``.
56   See :doc:`Lit <CommandGuide/lit>` for the details.
57
58 * Support for exception handling has been removed from the old JIT. Use MCJIT
59   if you need EH support.
60
61 * The R600 backend is not marked experimental anymore and is built by default.
62
63 * APFloat::isNormal() was renamed to APFloat::isFiniteNonZero() and
64   APFloat::isIEEENormal() was renamed to APFloat::isNormal(). This ensures that
65   APFloat::isNormal() conforms to IEEE-754R-2008.
66
67 * The library call simplification pass has been removed.  Its functionality
68   has been integrated into the instruction combiner and function attribute
69   marking passes.
70
71 * Support for building using Visual Studio 2008 has been dropped. Use VS 2010
72   or later instead. For more information, see the `Getting Started using Visual
73   Studio <GettingStartedVS.html>`_ page.
74
75 * The Loop Vectorizer that was previously enabled for -O3 is now enabled for
76   -Os and -O2.
77
78 * The new SLP Vectorizer is now enabled by default.
79
80 * llvm-ar now uses the new Object library and produces archives and
81   symbol tables in the gnu format.
82
83 * ... next change ...
84
85 .. NOTE
86    If you would like to document a larger change, then you can add a
87    subsection about it right here. You can copy the following boilerplate
88    and un-indent it (the indentation causes it to be inside this comment).
89
90    Special New Feature
91    -------------------
92
93    Makes programs 10x faster by doing Special New Thing.
94
95
96 External Open Source Projects Using LLVM 3.4
97 ============================================
98
99 An exciting aspect of LLVM is that it is used as an enabling technology for
100 a lot of other language and tools projects. This section lists some of the
101 projects that have already been updated to work with LLVM 3.4.
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>`_.
116